@@ -8,11 +8,12 @@ There are lots and lots of ways to get involved, this document covers:
8
8
* [ bug reports] ( #bug-reports )
9
9
* [ feature requests] ( #feature-requests )
10
10
* [ change requests] ( #change-requests )
11
- * [ working on MathJax core] ( #working-on-MathJax-core )
11
+ * [ working on MathJax core] ( #working-on-mathjax-core )
12
+ * [ key branches and tags] ( #key-branches--tags )
12
13
* [ submitting pull requests] ( #submitting-pull-requests )
13
- * [ testing and quality assurance] ( #testing-and-quality-assurance )
14
- * [ writing documentation] ( #writing-documentation )
15
- * [ translation] ( #translation )
14
+ * [ testing and quality assurance] ( #testing-and-quality-assurance )
15
+ * [ writing documentation] ( #writing-documentation )
16
+ * [ translation] ( #translation )
16
17
* [ Conduct] ( #conduct )
17
18
18
19
@@ -137,10 +138,12 @@ You want to contribute code? Fantastic! Let's get you started.
137
138
To get it out of the way:
138
139
139
140
- ** [ develop] ( https://github.com/MathJax/MathJax/tree/develop ) ** is
140
- the development branch. All work on the next release is here. Do
141
- ** NOT** use this branch for a production site.
141
+ the development branch. All work on the next release happens here so
142
+ you should generally branch of ` develop ` . Do ** NOT** use this branch
143
+ for a production site.
142
144
- ** [ master] ( https://github.com/MathJax/MathJax ) ** contains the latest
143
- release of MathJax. This branch may be used in production.
145
+ release of MathJax. This branch may be used in production. Do
146
+ ** NOT** use this branch to work on MathJax's source.
144
147
145
148
### Submitting Pull Requests
146
149
@@ -187,16 +190,14 @@ requests in the same way as branches:
187
190
< https://gist.github.com/piscisaureus/3342247 > .
188
191
189
192
190
- ### Documentation
193
+ ### Writing documentation
191
194
192
195
MathJax's main documentation can be found at [ docs.mathjax.org] ( http://docs.mathjax.org ) .
196
+ The source of the docs is hosted in the
197
+ [ mathjax/mathjax-docs] ( http://github.com/mathjax/mathjax-docs ) repo here on GitHub.
193
198
194
- The documentation is generated using
195
- [ Sphinx-doc] ( http://sphinx-doc.org/ ) and hosted on [ Read the
196
- docs] ( http://readthedocs.org ) . The source of the docs is hosted in the
197
- [ MathJax-Docs GitHub
198
- repository] ( http://github.com/mathjax/mathjax-docs ) .
199
-
199
+ The documentation is generated using [ Sphinx-doc] ( http://sphinx-doc.org/ ) and hosted on
200
+ [ Read the docs] ( http://readthedocs.org ) .
200
201
You can clone the repo and submit pull requests following the
201
202
[ pull-request] ( #submitting-pull-requests ) guidelines.
202
203
@@ -213,7 +214,7 @@ TranslateWiki.net, head over to the
213
214
[ mathjax/mathjax-i18n] ( https://github.com/mathjax/MathJax-i18n )
214
215
repository.
215
216
216
- # Conduct
217
+ ## Conduct
217
218
218
219
We are committed to providing a friendly, safe and welcoming environment for
219
220
all, regardless of gender, sexual orientation, disability, ethnicity, religion,
@@ -249,7 +250,7 @@ behaviour is not welcome.
249
250
We also suggest to read [ discourse's
250
251
rules] ( http://blog.discourse.org/2013/03/the-universal-rules-of-civilized-discourse/ )
251
252
252
- ### References
253
+ ## References
253
254
254
255
* We heavily borrowed from Mozilla and Ghost -- thank you!
255
256
* https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md
0 commit comments