|
| 1 | +# Contributing to Pro Git (2nd Edition) |
| 2 | + |
| 3 | +## Licensing your work to us |
| 4 | + |
| 5 | +When you open a pull request, you agree to provide your work under the [project license](LICENSE.asc). |
| 6 | +Also, you agree to grant such license of your work as is required for the purposes of future print editions to @ben and @schacon. |
| 7 | +Should your changes appear in a printed edition, you'll be included in the [contributors list](book/contributors.asc). |
| 8 | + |
| 9 | +## Signaling an Issue |
| 10 | + |
| 11 | +Search for similar issues, before creating a new issue. |
| 12 | + |
| 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. |
| 15 | + |
| 16 | +## Small Corrections |
| 17 | + |
| 18 | +Errata and basic clarifications will be accepted if we agree that they improve the content. |
| 19 | +You can also open an issue so that we can discuss how or if the issue needs to be addressed. |
| 20 | + |
| 21 | +If you've never done this before, the [flow guide](https://guides.github.com/introduction/flow/) might be useful. |
| 22 | + |
| 23 | +## Large Rewrites |
| 24 | + |
| 25 | +Open an issue for discussion before you start. |
| 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. |
| 29 | + |
| 30 | +## Figures |
| 31 | + |
| 32 | +The images in this book are generated using [Sketch 3](https://www.sketchapp.com/), with the [included sketchbook file](diagram-source/progit.sketch). |
| 33 | + |
| 34 | +To create a figure: |
| 35 | + |
| 36 | +1. Add a page to the sketchbook. |
| 37 | +Use the included symbols wherever possible. |
| 38 | +2. Add a "slice" to your page. |
| 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". |
| 41 | + |
| 42 | +## Translations |
| 43 | + |
| 44 | +If you want to contribute to translating Pro Git into your language, take a look at [TRANSLATING.md](TRANSLATING.md). |
0 commit comments