mirror of
https://github.com/octoleo/restic.git
synced 2024-12-23 03:18:55 +00:00
Reword parts of Providing Patches in CONTRIBUTION.md
Primarily makes the request that contributors create a new branch for their changes stand out more.
This commit is contained in:
parent
b17bd7f860
commit
c4336978eb
@ -125,15 +125,14 @@ down to the following steps:
|
|||||||
GitHub. For a new feature, please add an issue before starting to work on
|
GitHub. For a new feature, please add an issue before starting to work on
|
||||||
it, so that duplicate work is prevented.
|
it, so that duplicate work is prevented.
|
||||||
|
|
||||||
1. First we would kindly ask you to fork our project on GitHub if you haven't
|
1. Next, fork our project on GitHub if you haven't done so already.
|
||||||
done so already.
|
|
||||||
|
|
||||||
2. Clone the repository locally and create a new branch. If you are working on
|
2. Clone your fork of the repository locally and **create a new branch** for
|
||||||
the code itself, please set up the development environment as described in
|
your changes. If you are working on the code itself, please set up the
|
||||||
the previous section.
|
development environment as described in the previous section.
|
||||||
|
|
||||||
3. Then commit your changes as fine grained as possible, as smaller patches,
|
3. Commit your changes to the new branch as fine grained as possible, as
|
||||||
that handle one and only one issue are easier to discuss and merge.
|
smaller patches, for individual changes, are easier to discuss and merge.
|
||||||
|
|
||||||
4. Push the new branch with your changes to your fork of the repository.
|
4. Push the new branch with your changes to your fork of the repository.
|
||||||
|
|
||||||
@ -146,20 +145,19 @@ 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
|
7. If your pull request changes anything that users should be aware of
|
||||||
of (a bugfix, a new feature, ...) please add an entry as a new
|
(a bugfix, a new feature, ...) please add an entry as a new file in
|
||||||
file in `changelog/unreleased` including the issue number in the
|
`changelog/unreleased` including the issue number in the filename (e.g.
|
||||||
filename (e.g. `issue-8756`). Use the template in
|
`issue-8756`). Use the template in `changelog/TEMPLATE` for the content.
|
||||||
`changelog/TEMPLATE` for the content. It will be used in the
|
It will be used in the announcement of the next stable release. While
|
||||||
announcement of the next stable release. While writing, ask
|
writing, ask yourself: If I were the user, what would I need to be aware
|
||||||
yourself: If I were the user, what would I need to be aware of
|
of with this change?
|
||||||
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!
|
||||||
|
|
||||||
Please provide the patches for each bug or feature in a separate branch and
|
Please provide the patches for each bug or feature in a separate branch and
|
||||||
open up a pull request for each.
|
open up a pull request for each, as this simplifies discussion and merging.
|
||||||
|
|
||||||
The restic project uses the `gofmt` tool for Go source indentation, so please
|
The restic project uses the `gofmt` tool for Go source indentation, so please
|
||||||
run
|
run
|
||||||
|
Loading…
Reference in New Issue
Block a user