You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+51-24Lines changed: 51 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Contributing to MathJax
2
2
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.
4
6
5
7
There are lots and lots of ways to get involved, this document covers:
6
8
@@ -47,17 +49,33 @@ Guidelines for bug reports:
47
49
1.**Use the GitHub issue search**— check if the issue has already been
48
50
reported.
49
51
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
@@ -69,6 +87,7 @@ more information. Be sure to include the details of your environment.
69
87
Here is a [real example](https://github.com/mathjax/MathJax/issues/820)
70
88
71
89
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
+
72
91
```
73
92
Short and descriptive example bug report title
74
93
@@ -216,6 +235,10 @@ repository.
216
235
217
236
## Conduct
218
237
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
+
219
242
We are committed to providing a friendly, safe and welcoming environment for
220
243
all, regardless of gender, sexual orientation, disability, ethnicity, religion,
221
244
or similar personal characteristic.
@@ -229,26 +252,30 @@ circumstances.
229
252
Please keep unstructured critique to a minimum. If you have solid ideas you
230
253
want to experiment with, make a fork and see how it works.
231
254
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
0 commit comments