octoleo
/
restic
mirror of https://github.com/octoleo/restic.git
2
2
Fork 0
Code Issues Releases Wiki Activity

Update documentation for contributing 

- No need to checkout into `GOPATH` anymore
 - `CHANGELOG.md` shouldn't be updated directly
This commit is contained in:
Vincent Bernat 2019-06-14 23:00:46 +02:00
parent b6f01ffbe6
commit 3087776135
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -133,8 +133,7 @@ down to the following steps:
2. Clone the repository locally and create a new branch. If you are working on 2. Clone the repository locally and create a new branch. If you are working on
the code itself, please set up the development environment as described in the code itself, please set up the development environment as described in
the previous section. Especially take care to place your forked repository the previous section.
at the correct path (`src/github.com/restic/restic`) within your `GOPATH`.
3. Then commit your changes as fine grained as possible, as smaller patches, 3. Then commit your changes as fine grained as possible, as smaller patches,
that handle one and only one issue are easier to discuss and merge. that handle one and only one issue are easier to discuss and merge.
@ -150,11 +149,14 @@ down to the following steps:
existing commit, use common sense to decide which is better), they will be existing commit, use common sense to decide which is better), they will be
automatically added to the pull request. automatically added to the pull request.
7. If your pull request changes anything that users should be aware of (a 7. If your pull request changes anything that users should be aware
bugfix, a new feature, ...) please add an entry to the file of (a bugfix, a new feature, ...) please add an entry as a new
['CHANGELOG.md'](CHANGELOG.md). It will be used in the announcement of the file in `changelog/unreleased` including the issue number in the
next stable release. While writing, ask yourself: If I were the user, what filename (e.g. `issue-8756`). Use the template in
would I need to be aware of with this change. `changelog/TEMPLATE` for the content. It will be used in the
announcement of the next stable release. While writing, ask
yourself: If I were the user, what would I need to be aware of
with this change.
8. Once your code looks good and passes all the tests, we'll merge it. Thanks 8. Once your code looks good and passes all the tests, we'll merge it. Thanks
a lot for your contribution! a lot for your contribution!