Skip to content

Commit 39c61f6

Browse files
committed
Merge branch 'update-code-of-conduct'
2 parents 419b0a6 + c26e652 commit 39c61f6

File tree

1 file changed

+51
-24
lines changed

1 file changed

+51
-24
lines changed

CONTRIBUTING.md

Lines changed: 51 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Contributing to MathJax
22

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.
3+
You are 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.
46

57
There are lots and lots of ways to get involved, this document covers:
68

@@ -47,17 +49,33 @@ Guidelines for bug reports:
4749
1. **Use the GitHub issue search** — check if the issue has already been
4850
reported.
4951

50-
2. **Check if the issue has been fixed** — look for [closed issues in the
51-
current milestone](https://github.com/MathJax/MathJax/issues?&page=1&state=closed) or try to reproduce it
52-
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.
53-
54-
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.
55-
56-
4. **Isolate the problem** — a live sample is a starting point but if you want to speed things up create a [reduced test
57-
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.
58-
59-
5. **Include a screenshot/cast as a last resort** — Is your issue about a layout
60-
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!
52+
2. **Check if the issue has been fixed** — look for [closed
53+
issues in the current
54+
milestone](https://github.com/MathJax/MathJax/issues?&page=1&state=closed)
55+
or try to reproduce it using the latest `develop` branch. Please
56+
note that we only pack MathJax for releases, so on the `develop`
57+
branch you have to use `/unpacked/MathJax.js` etc. to test.
58+
59+
3. **Share a live sample of the problem** — without a live page
60+
it is usually impossible to debug problems; see also the Bug Report
61+
Template below.
62+
63+
4. **Isolate the problem** — a live sample is a starting point
64+
but if you want to speed things up create a [reduced test
65+
case](http://css-tricks.com/6263-reduced-test-cases/). Be specific
66+
about your setup (browser, OS versions etc). Use services like
67+
[jsbin](http://jsbin.com), [CodePen](http://codepen.io),
68+
[JSfiddle](http://jsfiddle.com) to make collaboration on minimal
69+
test cases easier for everyone. Use the unpacked copy of MathJax
70+
(`[...]/unpacked/MathJax.js` etc.) for better debugging.
71+
72+
5. **Include a screenshot/cast as a last resort** — Is your
73+
issue about a layout or design feature / bug but hard to reproduce
74+
or isolate? Then please provide a screenshot or screencast. Tools
75+
like [LICEcap](http://www.cockos.com/licecap/) or
76+
[SauceLabs](http://www.saucelabs.com) allow you to quickly and
77+
easily record a screencasts. Make it an animated gif, embed it
78+
directly into your GitHub issue -- kapow!
6179

6280
6. Use the Bug Report template below or [click this
6381
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)
@@ -69,6 +87,7 @@ more information. Be sure to include the details of your environment.
6987
Here is a [real example](https://github.com/mathjax/MathJax/issues/820)
7088

7189
Template Example ([click to use](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)):
90+
7291
```
7392
Short and descriptive example bug report title
7493
@@ -216,6 +235,10 @@ repository.
216235

217236
## Conduct
218237

238+
As a NumFOCUS fiscally sponsored project, MathJax is governed by the
239+
[NumFOCUS code of conduct](https://numfocus.org/code-of-conduct),
240+
which we summarize as follows:
241+
219242
We are committed to providing a friendly, safe and welcoming environment for
220243
all, regardless of gender, sexual orientation, disability, ethnicity, religion,
221244
or similar personal characteristic.
@@ -229,26 +252,30 @@ circumstances.
229252
Please keep unstructured critique to a minimum. If you have solid ideas you
230253
want to experiment with, make a fork and see how it works.
231254

232-
We will exclude you from interaction if you insult, demean or harass anyone.
233-
That is not welcome behaviour. We interpret the term "harassment" as
234-
including the definition in the
235-
[Citizen Code of Conduct](http://citizencodeofconduct.org/);
236-
if you have any lack of clarity about what might be included in that concept,
237-
please read their definition. In particular, we don't tolerate behavior that
255+
We will exclude you from interaction if you insult, demean or harass
256+
anyone. That is not welcome behaviour. We interpret the term
257+
"harassment" as including the definition in the [Unacceptable
258+
Behavior](https://numfocus.org/code-of-conduct#unacceptable-behavior)
259+
section of the [NumFOCUS code of
260+
conduct](https://numfocus.org/code-of-conduct); if you have any lack
261+
of clarity about what might be included in that concept, please read
262+
that definition. In particular, we don't tolerate behavior that
238263
excludes people in socially marginalized groups.
239264

240-
Private harassment is also unacceptable. No matter who you are, if you feel
241-
you have been or are being harassed or made uncomfortable by a community
242-
member, please contact one of the channel ops or any of the
265+
Private harassment is also unacceptable. No matter who you are, if you
266+
feel you have been or are being harassed or made uncomfortable by a
267+
community member, please contact one of the channel ops or any of the
243268
[MathJax](https://github.com/MathJax/MathJax) core team
244-
immediately. Whether you're a regular contributor or a newcomer, we care about
245-
making this community a safe place for you and we've got your back.
269+
immediately. Whether you're a regular contributor or a newcomer, we
270+
care about making this community a safe place for you and we've got
271+
your back.
246272

247273
Likewise any spamming, trolling, flaming, baiting or other attention-stealing
248274
behaviour is not welcome.
249275

250-
We also suggest to read [discourse's
276+
We also recommend that you read [discourse's
251277
rules](http://blog.discourse.org/2013/03/the-universal-rules-of-civilized-discourse/)
278+
for further suggestions on appropriate behavior.
252279

253280
## References
254281

0 commit comments

Comments
 (0)