updating contributing.md
* Fix more relative links * fix TOC structure * minor changes to core section
This commit is contained in:
parent
79127fb44b
commit
f22a1adab7
|
@ -8,7 +8,8 @@ There are lots and lots of ways to get involved, this document covers:
|
||||||
* [bug reports](#bug-reports)
|
* [bug reports](#bug-reports)
|
||||||
* [feature requests](#feature-requests)
|
* [feature requests](#feature-requests)
|
||||||
* [change requests](#change-requests)
|
* [change requests](#change-requests)
|
||||||
* [working on MathJax core](#working-on-MathJax-core)
|
* [working on MathJax core](#working-on-mathjax-core)
|
||||||
|
* [key branches and tags](#key-branches--tags)
|
||||||
* [submitting pull requests](#submitting-pull-requests)
|
* [submitting pull requests](#submitting-pull-requests)
|
||||||
* [testing and quality assurance](#testing-and-quality-assurance)
|
* [testing and quality assurance](#testing-and-quality-assurance)
|
||||||
* [writing documentation](#writing-documentation)
|
* [writing documentation](#writing-documentation)
|
||||||
|
@ -137,10 +138,12 @@ You want to contribute code? Fantastic! Let's get you started.
|
||||||
To get it out of the way:
|
To get it out of the way:
|
||||||
|
|
||||||
- **[develop](https://github.com/MathJax/MathJax/tree/develop)** is
|
- **[develop](https://github.com/MathJax/MathJax/tree/develop)** is
|
||||||
the development branch. All work on the next release is here. Do
|
the development branch. All work on the next release happens here so
|
||||||
**NOT** use this branch for a production site.
|
you should generally branch of `develop`. Do **NOT** use this branch
|
||||||
|
for a production site.
|
||||||
- **[master](https://github.com/MathJax/MathJax)** contains the latest
|
- **[master](https://github.com/MathJax/MathJax)** contains the latest
|
||||||
release of MathJax. This branch may be used in production.
|
release of MathJax. This branch may be used in production. Do
|
||||||
|
**NOT** use this branch to work on MathJax's source.
|
||||||
|
|
||||||
### Submitting Pull Requests
|
### Submitting Pull Requests
|
||||||
|
|
||||||
|
@ -187,16 +190,14 @@ requests in the same way as branches:
|
||||||
<https://gist.github.com/piscisaureus/3342247>.
|
<https://gist.github.com/piscisaureus/3342247>.
|
||||||
|
|
||||||
|
|
||||||
### Documentation
|
### Writing documentation
|
||||||
|
|
||||||
MathJax's main documentation can be found at [docs.mathjax.org](http://docs.mathjax.org).
|
MathJax's main documentation can be found at [docs.mathjax.org](http://docs.mathjax.org).
|
||||||
|
The source of the docs is hosted in the
|
||||||
|
[mathjax/mathjax-docs](http://github.com/mathjax/mathjax-docs) repo here on GitHub.
|
||||||
|
|
||||||
The documentation is generated using
|
The documentation is generated using [Sphinx-doc](http://sphinx-doc.org/) and hosted on
|
||||||
[Sphinx-doc](http://sphinx-doc.org/) and hosted on [Read the
|
[Read the docs](http://readthedocs.org).
|
||||||
docs](http://readthedocs.org). The source of the docs is hosted in the
|
|
||||||
[MathJax-Docs GitHub
|
|
||||||
repository](http://github.com/mathjax/mathjax-docs).
|
|
||||||
|
|
||||||
You can clone the repo and submit pull requests following the
|
You can clone the repo and submit pull requests following the
|
||||||
[pull-request](#submitting-pull-requests) guidelines.
|
[pull-request](#submitting-pull-requests) guidelines.
|
||||||
|
|
||||||
|
@ -213,7 +214,7 @@ TranslateWiki.net, head over to the
|
||||||
[mathjax/mathjax-i18n](https://github.com/mathjax/MathJax-i18n)
|
[mathjax/mathjax-i18n](https://github.com/mathjax/MathJax-i18n)
|
||||||
repository.
|
repository.
|
||||||
|
|
||||||
# Conduct
|
## Conduct
|
||||||
|
|
||||||
We are committed to providing a friendly, safe and welcoming environment for
|
We are committed to providing a friendly, safe and welcoming environment for
|
||||||
all, regardless of gender, sexual orientation, disability, ethnicity, religion,
|
all, regardless of gender, sexual orientation, disability, ethnicity, religion,
|
||||||
|
@ -249,7 +250,7 @@ behaviour is not welcome.
|
||||||
We also suggest to read [discourse's
|
We also suggest to read [discourse's
|
||||||
rules](http://blog.discourse.org/2013/03/the-universal-rules-of-civilized-discourse/)
|
rules](http://blog.discourse.org/2013/03/the-universal-rules-of-civilized-discourse/)
|
||||||
|
|
||||||
### References
|
## References
|
||||||
|
|
||||||
* We heavily borrowed from Mozilla and Ghost -- thank you!
|
* We heavily borrowed from Mozilla and Ghost -- thank you!
|
||||||
* https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md
|
* https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md
|
||||||
|
|
Loading…
Reference in New Issue
Block a user