Skip to content

Commit b4c27f5

Browse files
committed
Translation and figure notes -> contributing.md
1 parent 31acb6c commit b4c27f5

File tree

2 files changed

+20
-23
lines changed

2 files changed

+20
-23
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Licensing
55

6-
By opening a pull request to this repository, you agree to provide your work under the [project license](LICENSE.asc).
6+
By opening a pull request to this repository, you agree to provide your work under the [project license](LICENSE.asc).
77

88
## Small Corrections
99

@@ -15,6 +15,21 @@ If you've never done this before, the [flow guide](https://guides.github.com/int
1515

1616
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.
1717

18-
## Translate
18+
## Figures
1919

20-
If you're interested in translating Pro Git into another language, [read the translation guide](TRANSLATION_NOTES.asc).
20+
The images in this book were generated using [Sketch 3](http://bohemiancoding.com/sketch/), with the [included sketchbook file](diagram-source/progit.sketch).
21+
22+
To add a figure:
23+
24+
1. Add a page to the sketchbook. Try to use the included symbols wherever possible.
25+
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.
26+
1. Make sure your slice is set to export at 3x size.
27+
28+
29+
## Translations
30+
31+
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.
32+
33+
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).
34+
35+
You can find out information on all the current translations and information on how to start your own at http://progit.org/translations.

README.asc

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ A couple of things have changed since open sourcing the first edition. For one,
1010

1111
We've also moved to keeping the translations in separate repositories rather than subdirectories of the English repository. See the Translations section for more information.
1212

13-
== Contributing
14-
15-
If you'd like to help out, take a look at the [contributor's guide](CONTRIBUTING.md).
16-
1713
== How To Generate the Book
1814

1915
There are two ways to generate e-book content from this source code.
@@ -39,20 +35,6 @@ Converting to PDF...
3935

4036
This uses the `asciidoctor`, `asciidoctor-pdf` and `asciidoctor-epub` projects.
4137

42-
== Translations
43-
44-
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.
45-
46-
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 https://github.com/progit[progit organization on GitHub].
47-
48-
You can find out information on all the current translations and information on how to start your own at: http://progit.org/translations[].
49-
50-
== Figures
51-
52-
The images in this book were generated using http://bohemiancoding.com/sketch/[Sketch 3], with the link:diagram-source/progit.sketch[included sketchbook file].
53-
54-
To add a figure:
38+
== Contributing
5539

56-
. Add a page to the sketchbook. Try to use the included symbols wherever possible.
57-
. Add a ``slice'' to your page. Give it a name that matches the destination PNG filename, relative from the root of the source directory.
58-
. Make sure your slice is set to export at 3x size.
40+
If you'd like to help out by making a change or contributing a translation, take a look at the [contributor's guide](CONTRIBUTING.md).

0 commit comments

Comments
 (0)