From 5ebd64c50862099f59fe7831a2e25463a9c6dd65 Mon Sep 17 00:00:00 2001 From: Thibaut CHARLES Date: Wed, 9 May 2018 14:34:50 +0200 Subject: [PATCH] Added notes for contributing to dependencies (#435) Signed-off-by: Thibaut CHARLES cromfr@gmail.com --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99c85331a..828ed2b7a 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