Skip to content

Commit bdcf56a

Browse files
committed
Improve the text with the following changes:
- Use the active voice where possible. - Use a clear title for the licensing section. - Break up a long sentence in the large rewrite section. - Remove the word please, when we actually require something from a contributor. - Use simpler English words - Remove newline
1 parent 58e65f7 commit bdcf56a

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
11
# Contributing to Pro Git (2nd Edition)
22

3-
## Licensing
3+
## Licensing your work to us
44

5-
By opening a pull request to this repository, you agree to provide your work under the [project license](LICENSE.asc).
5+
When you open a pull request, you agree to provide your work under the [project license](LICENSE.asc).
66
Also, you agree to grant such license of your work as is required for the purposes of future print editions to @ben and @schacon.
77
Should your changes appear in a printed edition, you'll be included in the [contributors list](book/contributors.asc).
88

99
## Signaling an Issue
1010

11-
Before signaling an issue, please check that there isn't already a similar one in the bug tracking system.
11+
Search for similar issues, before creating a new issue.
1212

13-
Also, if this issue has been spotted on the git-scm.com site, please cross-check that it is still present in the pdf version.
14-
The issue may have already been corrected, but the changes have not been deployed yet.
13+
Also, if this issue has been spotted on the git-scm.com site, cross-check that the issue is present in the pdf version.
14+
The issue may have already been corrected in the source files, but not yet deployed to the git-scm.com site.
1515

1616
## Small Corrections
1717

1818
Errata and basic clarifications will be accepted if we agree that they improve the content.
19-
You can also open an issue so we can figure out how or if it needs to be addressed.
19+
You can also open an issue so that we can discuss how or if the issue needs to be addressed.
2020

2121
If you've never done this before, the [flow guide](https://guides.github.com/introduction/flow/) might be useful.
2222

2323
## Large Rewrites
2424

2525
Open an issue for discussion before you start.
26-
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.
27-
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.
26+
A large rewrite tends to be very subjective, often only clarifying things for a small amount of readers.
27+
Professional copy editors have already reviewed this content multiple times.
28+
It's unlikely that your prose is going to be *so* much better that it's worth changing large portions of text.
2829

2930
## Figures
3031

31-
The images in this book were generated using [Sketch 3](https://www.sketchapp.com/), with the [included sketchbook file](diagram-source/progit.sketch).
32+
The images in this book are generated using [Sketch 3](https://www.sketchapp.com/), with the [included sketchbook file](diagram-source/progit.sketch).
3233

33-
To add a figure:
34+
To create a figure:
3435

3536
1. Add a page to the sketchbook.
36-
Try to use the included symbols wherever possible.
37+
Use the included symbols wherever possible.
3738
2. Add a "slice" to your page.
38-
Give it a name that matches the destination PNG filename, relative from the root of the source directory.
39-
3. Make sure your slice is set to export at "800w".
40-
39+
Name the slice so that it matches the destination PNG filename, relative from the root of the source directory.
40+
3. Set your slice to export at "800w".
4141

4242
## Translations
4343

44-
If you would like to contribute to translating Pro Git into your language, take a look at [TRANSLATING.md](TRANSLATING.md).
44+
If you want to contribute to translating Pro Git into your language, take a look at [TRANSLATING.md](TRANSLATING.md).

0 commit comments

Comments
 (0)