diff options
| author | Thibaut CHARLES <cromfr@gmail.com> | 2018-05-09 14:34:50 +0200 |
|---|---|---|
| committer | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2018-05-09 13:34:50 +0100 |
| commit | 5ebd64c50862099f59fe7831a2e25463a9c6dd65 (patch) | |
| tree | 5330144bd7625457f1f015b684138b0a30cdff29 /CONTRIBUTING.md | |
| parent | 1f61537d661abebb99d74f43fa66005eb5c114c4 (diff) | |
Added notes for contributing to dependencies (#435)
Signed-off-by: Thibaut CHARLES cromfr@gmail.com
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99c85331..828ed2b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,6 +33,18 @@ nonetheless fairly well-contained. We ask people who are familiar with Dendrite to leave the [good first issue](https://github.com/matrix-org/dendrite/labels/good%20first%20issue) issues so that there is always a way for new people to come and get involved. +## Contributing to dependencies + +Dependencies are located in `vendor/src` and are managed by `gb`. If you need +to make some changes in those directories, you first need to open a PR in the +dependency repository. Once your PR is merged, you need to run `gb vendor +update $repo_url` (example: `gb vendor update github.com/matrix-org/gomatrix`) +in the dendrite repository to update the dependency. + +You can then create a commit containing only the modified vendor files (along +with the `vendor/manifest` file), name it with the command you just ran (ie +`gb vendor update github.com/matrix-org/gomatrix`), and open a PR on Dendrite. + ## Getting Help For questions related to developing on Dendrite we have a dedicated room on |