From 5254ee076cd46feb9a08e0e2211dcad983db3afe Mon Sep 17 00:00:00 2001 From: Thibaut CHARLES Date: Wed, 9 May 2018 12:46:17 +0200 Subject: [PATCH] better info for committing & minor corrections --- CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0bd9c80f..8028c35f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,9 +35,15 @@ 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 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 dendrite repository to update the dependency. +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 commit the modified files and name the commit with the command you just ran. +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