Skip to content

Commit 31acb6c

Browse files
committed
Contributing.md
1 parent d8b780c commit 31acb6c

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Contributing to Pro Git (2nd Edition)
2+
3+
4+
## Licensing
5+
6+
By opening a pull request to this repository, you agree to provide your work under the [project license](LICENSE.asc).
7+
8+
## Small Corrections
9+
10+
Errata and basic clarifications will be accepted if we agree that they improve the content. You can also open an issue so we can figure out how or if it needs to be addressed.
11+
12+
If you've never done this before, the [flow guide](https://guides.github.com/introduction/flow/) might be useful.
13+
14+
## Large Rewrites
15+
16+
Open an issue for discussion before you start. These changes tend to be very subjective, often only clarifying things for some small percentage of people and it's rarely worth the time to accept them. Professional copy editors have already reviewed this content multiple times so while you may have somewhat better taste and grammar than we do it's unlikely that your prose is going to be *so* much better that it's worth changing vast swaths of text.
17+
18+
## Translate
19+
20+
If you're interested in translating Pro Git into another language, [read the translation guide](TRANSLATION_NOTES.asc).

README.asc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,7 @@ We've also moved to keeping the translations in separate repositories rather tha
1212

1313
== Contributing
1414

15-
To contribute errata or new content to this repository, you will need to open up a Pull Request on GitHub. It is generally a good idea before doing anything major to open an issue and make sure your work will get accepted.
16-
17-
Errata and basic clarifications will be accepted if we agree that they improve the content. You can also open an issue so we can figure out how or if it needs to be addressed.
18-
19-
Please refrain from making sweeping copy edit changes as they tend to not get accepted and we don't want you wasting your time. These changes tend to be very subjective, often only clarifying things for some small percentage of people and it's rarely worth the time to accept them. Professional copy editors have already reviewed this content multiple times so while you may have somewhat better taste and grammar than we do it's unlikely that your prose is going to be *so* much better that it's worth changing vast swaths of text.
15+
If you'd like to help out, take a look at the [contributor's guide](CONTRIBUTING.md).
2016

2117
== How To Generate the Book
2218

0 commit comments

Comments
 (0)