Marown/git-filter-repo
1
0
Fork 0
mirror of https://github.com/newren/git-filter-repo.git synced 2024-07-06 18:32:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Contributing.md: start with git guidelines, then mention exceptions

Browse Source 
Signed-off-by: Elijah Newren <newren@gmail.com>
This commit is contained in:
Elijah Newren 2020-02-01 09:46:52 -08:00
parent 18f98295e4
commit 96e217355c
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Documentation/Contributing.md
View File

@ -1,26 +1,5 @@
Welcome to the community! Welcome to the community!
There are a few filter-repo specific guidelines to keep in mind:
* Please test line coverage if you add or modify code
* `make test` will run the testsuite under
[coverage3](https://pypi.org/project/coverage/) (which you will
need to install), and report on line coverage. Line coverage of
git-filter-repo needs to remain at 100%.
* Please do not be intimidated by detailed feedback:
* In the git community, I have been contributing for years and
have had hundreds of patches accepted but I still find that even
when I try to make patches perfect I am not surprised when I
have to spend as much or more time fixing up patches after
submitting them than I did figuring out the patches in the first
place. git folks tend to do thorough reviews, which has taught
me a lot, and I try to do the same for filter-repo. Plus, as
noted below, I want contributions from others to be acceptable
in git.git itself.
Contributions need to meet the bar for inclusion in git.git. Although Contributions need to meet the bar for inclusion in git.git. Although
filter-repo is not part of the git.git repository, I want to leave the filter-repo is not part of the git.git repository, I want to leave the
option open for it to be merged in the future. As such, any option open for it to be merged in the future. As such, any
@ -70,3 +49,24 @@ with a few exceptions:
two-space indents for years before learning of it and have just two-space indents for years before learning of it and have just
continued that habit. For consistency, contributions should also continued that habit. For consistency, contributions should also
use two-space indents and otherwise generally follow PEP 8. use two-space indents and otherwise generally follow PEP 8.
There are a few extra things I would like folks to keep in mind:
* Please test line coverage if you add or modify code
* `make test` will run the testsuite under
[coverage3](https://pypi.org/project/coverage/) (which you will
need to install), and report on line coverage. Line coverage of
git-filter-repo needs to remain at 100%.
* Please do not be intimidated by detailed feedback:
* In the git community, I have been contributing for years and
have had hundreds of patches accepted but I still find that even
when I try to make patches perfect I am not surprised when I
have to spend as much or more time fixing up patches after
submitting them than I did figuring out the patches in the first
place. git folks tend to do thorough reviews, which has taught
me a lot, and I try to do the same for filter-repo. Plus, as
noted above, I want contributions from others to be acceptable
in git.git itself.