|
1 | 1 | # Contributing to Pro Git (2nd Edition) |
2 | 2 |
|
| 3 | +## Licensing your work to us |
3 | 4 |
|
4 | | -## Licensing |
5 | | - |
6 | | -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). |
7 | 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. |
8 | 7 | Should your changes appear in a printed edition, you'll be included in the [contributors list](book/contributors.asc). |
9 | 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 | + |
10 | 16 | ## Small Corrections |
11 | 17 |
|
12 | | -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 | +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. |
13 | 20 |
|
14 | | -If you've never done this before, the [flow guide](https://guides.github.com/introduction/flow/) might be useful. |
| 21 | +If you've never done this before, the [flow guide](https://docs.github.com/en/get-started/quickstart/github-flow) might be useful. |
15 | 22 |
|
16 | 23 | ## Large Rewrites |
17 | 24 |
|
18 | | -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. |
| 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. |
19 | 29 |
|
20 | 30 | ## Figures |
21 | 31 |
|
22 | | -The images in this book were generated using [Sketch 3](http://bohemiancoding.com/sketch/), with the [included sketchbook file](diagram-source/progit.sketch). |
| 32 | +The images in this book are generated using [Sketch 3](https://www.sketch.com/), with the [included sketchbook file](diagram-source/progit.sketch). |
23 | 33 |
|
24 | | -To add a figure: |
25 | | - |
26 | | -1. Add a page to the sketchbook. Try to use the included symbols wherever possible. |
27 | | -1. Add a "slice" to your page. Give it a name that matches the destination PNG filename, relative from the root of the source directory. |
28 | | -1. Make sure your slice is set to export at "800w". |
| 34 | +To create a figure: |
29 | 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". |
30 | 41 |
|
31 | 42 | ## Translations |
32 | 43 |
|
33 | | -Translations to other languages are highly encouraged but handled a little differently than the first edition. We now keep each translation in a separate repository and automatically build the output files through Atlas. This was something that was really difficult in the last edition. |
34 | | - |
35 | | -Since each translation is a different repository, we can also have different maintainers for each project. The Pro Git team simply pulls them in and builds them for the translation teams. To get automatic builds, translations repositories will have to be under the [`progit` organization on GitHub](https://github.com/progit). |
36 | | - |
37 | | -You can find out information on all the current translations and information on how to start your own at http://progit.org/translations. |
| 44 | +If you want to contribute to translating Pro Git into your language, take a look at [TRANSLATING.md](TRANSLATING.md). |
0 commit comments