Skip to content

Commit 79127fb

Browse files
committed
Updating Commit.md
* fix broken links * re-write bug report instructions * restructure core development advice.
1 parent 65937e6 commit 79127fb

File tree

1 file changed

+31
-34
lines changed

1 file changed

+31
-34
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Contributing to MathJax
22

3-
So you're interested in giving us a hand? That's awesome! We've put
4-
together some brief guidelines that should help you get started
5-
quickly and easily.
3+
You are interested in giving us a hand? That's awesome! We've put together some brief guidelines that should help you get started quickly and easily.
64

75
There are lots and lots of ways to get involved, this document covers:
86

9-
* [raising issues](#raising-issues)
7+
* [reporting an issue](#reporting-an-issue)
108
* [bug reports](#bug-reports)
119
* [feature requests](#feature-requests)
1210
* [change requests](#change-requests)
@@ -33,7 +31,7 @@ requests](#submitting-pull-requests), but please respect the following restricti
3331
problem or requested your idea.
3432

3533
* Please **do not** use the issue tracker for personal support
36-
requests (use [the MathJax User Group](https://groups.google.com/forum/#!forum/mathjax-users).
34+
requests (use [the MathJax User Group](https://groups.google.com/forum/#!forum/mathjax-users)).
3735

3836
* Please **be civil**. Keep the discussion on topic and respect the
3937
opinions of others. See also our [Conduct Guidelines](#conduct)
@@ -48,21 +46,19 @@ Guidelines for bug reports:
4846
1. **Use the GitHub issue search** — check if the issue has already been
4947
reported.
5048

51-
2. **Check if the issue has been fixed** — try to reproduce it
52-
using the latest `develop` or look for [closed issues in the
53-
current milestone](https://github.com/MathJax/MathJax/issues?&page=1&state=closed).
49+
2. **Check if the issue has been fixed** — look for [closed issues in the
50+
current milestone](https://github.com/MathJax/MathJax/issues?&page=1&state=closed) or try to reproduce it
51+
using the latest `develop` branch. Please note that we only pack MathJax for releases, so on the `develop` branch you have to use `/unpacked/MathJax.js` etc. to test.
5452

55-
3. **Isolate the problem** — ideally create a [reduced test
56-
case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
53+
3. **Share a live sample of the problem** — without a live page it is usually impossible to debug problems; see also the Bug Report Template below.
5754

58-
4. **Include a screencast if relevant** - Is your issue about a design
59-
or front end feature or bug? The most helpful thing in the world is
60-
if we can *see* what you're talking about. Use
61-
[LICEcap](http://www.cockos.com/licecap/) to quickly and easily
62-
record a short screencast (24fps) and save it as an animated gif!
63-
Embed it directly into your GitHub issue. Kapow.
55+
4. **Isolate the problem** — a live sample is a starting point but if you want to speed things up create a [reduced test
56+
case](http://css-tricks.com/6263-reduced-test-cases/). Be specific about your setup (browser, OS versions etc). Use services like [jsbin](http://jsbin.com), [CodePen](http://codepen.io), [JSfiddle](http://jsfiddle.com) to make collaboration on minimal test cases easier for everyone. Use the unpacked copy of MathJax (`[...]/unpacked/MathJax.js` etc.) for better debugging.
6457

65-
5. Use the Bug Report template below or [click this
58+
5. **Include a screenshot/cast as a last resort** — Is your issue about a layout
59+
or design feature / bug but hard to reproduce or isolate? Then please provide a screenshot or screencast. Tools like [LICEcap](http://www.cockos.com/licecap/) or [SauceLabs](http://www.saucelabs.com) allow you to quickly and easily record a screencasts. Make it an animated gif, embed it directly into your GitHub issue -- kapow!
60+
61+
6. Use the Bug Report template below or [click this
6662
link](https://github.com/MathJax/MathJax/issues/new?title=Bug%3A&body=%23%23%23%20Issue%20Summary%0A%0A%23%23%23%20Steps%20to%20Reproduce%0A%0A1.%20This%20is%20the%20first%20step%0A%0AThis%20is%20a%20bug%20because...%0A%0A%23%23%23%20Technical%20details%0A%0A*%20MathJax%20Version%3A%20master%20-%20latest%20commit%3A%20%20INSERT%20COMMIT%20REF%0A*%20Client%20OS%3A%20%0A*%20Browser%3A%20%0A*%20)
6763
to start creating a bug report with the template automatically.
6864

@@ -132,12 +128,25 @@ a refactor, or an improvement to a feature, etc - please be sure to:
132128
are suggesting better than what's already there? Does it fit with
133129
the Roadmap?
134130

131+
## Working on MathJax core
132+
133+
You want to contribute code? Fantastic! Let's get you started.
134+
135+
### Key Branches & Tags
136+
137+
To get it out of the way:
138+
139+
- **[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.
142+
- **[master](https://github.com/MathJax/MathJax)** contains the latest
143+
release of MathJax. This branch may be used in production.
135144

136145
### Submitting Pull Requests
137146

138147
Pull requests are awesome. If you're looking to raise a PR for
139148
something which doesn't have an open issue, please think carefully
140-
about [raising an issue](#raising-issues) which your PR can close,
149+
about [raising an issue](#reporting-an-issue) which your PR can close,
141150
especially if you're fixing a bug. This makes it more likely that
142151
there will be enough information available for your PR to be properly
143152
tested and merged.
@@ -165,7 +174,7 @@ Documentation [in our testing
165174
framework](https://github.com/MathJax/MathJax-testing).
166175

167176
Essentially though, [check out the latest develop
168-
branch](#contribute-to-core), take it for a spin, and if you find
177+
branch](#working-on-mathJax-core), take it for a spin, and if you find
169178
anything odd, please follow the [bug report guidelines](#bug-reports)
170179
and let us know!
171180

@@ -189,33 +198,21 @@ docs](http://readthedocs.org). The source of the docs is hosted in the
189198
repository](http://github.com/mathjax/mathjax-docs).
190199

191200
You can clone the repo and submit pull requests following the
192-
[pull-request](#pull-requests) guidelines.
201+
[pull-request](#submitting-pull-requests) guidelines.
193202

194203

195204
### Translation
196205

197206
If you wish to add or update translations of MathJax, please do it on
198207
[TranslateWiki.net](https://translatewiki.net/w/i.php?title=Special:Translate&group=out-mathjax-0-all)
199208
(and while you're there you can help other open source projects,
200-
too!).
209+
too, because you're awesome!).
201210

202211
For bug reports and other questions that don't fit on
203212
TranslateWiki.net, head over to the
204213
[mathjax/mathjax-i18n](https://github.com/mathjax/MathJax-i18n)
205214
repository.
206215

207-
208-
## Working on MathJax Core {core}
209-
210-
### Key Branches & Tags
211-
212-
- **[develop](https://github.com/MathJax/MathJax/tree/develop)** is
213-
the development branch. All work on the next release is here. Do
214-
**NOT** use this branch for a production site.
215-
- **[master](https://github.com/MathJax/MathJax)** contains the latest
216-
release of MathJax. This branch may be used in production.
217-
218-
219216
# Conduct
220217

221218
We are committed to providing a friendly, safe and welcoming environment for
@@ -254,7 +251,7 @@ rules](http://blog.discourse.org/2013/03/the-universal-rules-of-civilized-discou
254251

255252
### References
256253

257-
* We heavily borrowed from -- thanks to Mozilla and Ghost!
254+
* We heavily borrowed from Mozilla and Ghost -- thank you!
258255
* https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md
259256
* https://github.com/mozilla/rust/wiki/Note-development-policy
260257
* https://github.com/jden/CONTRIBUTING.md/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)