Skip to content

Commit 96e2173

Browse files
committed
Contributing.md: start with git guidelines, then mention exceptions
Signed-off-by: Elijah Newren <[email protected]>
1 parent 18f9829 commit 96e2173

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

Documentation/Contributing.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,5 @@
11
Welcome to the community!
22

3-
There are a few filter-repo specific guidelines to keep in mind:
4-
5-
* Please test line coverage if you add or modify code
6-
7-
* `make test` will run the testsuite under
8-
[coverage3](https://pypi.org/project/coverage/) (which you will
9-
need to install), and report on line coverage. Line coverage of
10-
git-filter-repo needs to remain at 100%.
11-
12-
* Please do not be intimidated by detailed feedback:
13-
14-
* In the git community, I have been contributing for years and
15-
have had hundreds of patches accepted but I still find that even
16-
when I try to make patches perfect I am not surprised when I
17-
have to spend as much or more time fixing up patches after
18-
submitting them than I did figuring out the patches in the first
19-
place. git folks tend to do thorough reviews, which has taught
20-
me a lot, and I try to do the same for filter-repo. Plus, as
21-
noted below, I want contributions from others to be acceptable
22-
in git.git itself.
23-
243
Contributions need to meet the bar for inclusion in git.git. Although
254
filter-repo is not part of the git.git repository, I want to leave the
265
option open for it to be merged in the future. As such, any
@@ -70,3 +49,24 @@ with a few exceptions:
7049
two-space indents for years before learning of it and have just
7150
continued that habit. For consistency, contributions should also
7251
use two-space indents and otherwise generally follow PEP 8.
52+
53+
There are a few extra things I would like folks to keep in mind:
54+
55+
* Please test line coverage if you add or modify code
56+
57+
* `make test` will run the testsuite under
58+
[coverage3](https://pypi.org/project/coverage/) (which you will
59+
need to install), and report on line coverage. Line coverage of
60+
git-filter-repo needs to remain at 100%.
61+
62+
* Please do not be intimidated by detailed feedback:
63+
64+
* In the git community, I have been contributing for years and
65+
have had hundreds of patches accepted but I still find that even
66+
when I try to make patches perfect I am not surprised when I
67+
have to spend as much or more time fixing up patches after
68+
submitting them than I did figuring out the patches in the first
69+
place. git folks tend to do thorough reviews, which has taught
70+
me a lot, and I try to do the same for filter-repo. Plus, as
71+
noted above, I want contributions from others to be acceptable
72+
in git.git itself.

0 commit comments

Comments
 (0)