Skip to content

Commit f22a1ad

Browse files
committed
updating contributing.md
* Fix more relative links * fix TOC structure * minor changes to core section
1 parent 79127fb commit f22a1ad

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ There are lots and lots of ways to get involved, this document covers:
88
* [bug reports](#bug-reports)
99
* [feature requests](#feature-requests)
1010
* [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)
1213
* [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)
1617
* [Conduct](#conduct)
1718

1819

@@ -137,10 +138,12 @@ You want to contribute code? Fantastic! Let's get you started.
137138
To get it out of the way:
138139

139140
- **[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.
142144
- **[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.
144147

145148
### Submitting Pull Requests
146149

@@ -187,16 +190,14 @@ requests in the same way as branches:
187190
<https://gist.github.com/piscisaureus/3342247>.
188191

189192

190-
### Documentation
193+
### Writing documentation
191194

192195
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.
193198

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).
200201
You can clone the repo and submit pull requests following the
201202
[pull-request](#submitting-pull-requests) guidelines.
202203

@@ -213,7 +214,7 @@ TranslateWiki.net, head over to the
213214
[mathjax/mathjax-i18n](https://github.com/mathjax/MathJax-i18n)
214215
repository.
215216

216-
# Conduct
217+
## Conduct
217218

218219
We are committed to providing a friendly, safe and welcoming environment for
219220
all, regardless of gender, sexual orientation, disability, ethnicity, religion,
@@ -249,7 +250,7 @@ behaviour is not welcome.
249250
We also suggest to read [discourse's
250251
rules](http://blog.discourse.org/2013/03/the-universal-rules-of-civilized-discourse/)
251252

252-
### References
253+
## References
253254

254255
* We heavily borrowed from Mozilla and Ghost -- thank you!
255256
* https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)