Skip to content

Commit 107df86

Browse files
committed
Further improvements to CONTRIBUTING.md.
1 parent 54e0b1a commit 107df86

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

CONTRIBUTING.md

+22-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
11
Contributing
22
============
33

4-
1. Ensure that all tests pass (`make test`).
5-
2. Ensure that performance has not been affected (`make bench`).
6-
3. Use `make lint` to check for problems.
7-
4. Changes to `dist` should not be committed. (We will regenerate
8-
`dist/commonmark.js` before a release.)
9-
5. Follow the style of the existing code.
4+
Submitting bug reports
5+
----------------------
6+
7+
There is a [forum for discussing CommonMark](http://talk.commonmark.org);
8+
use it for questions and discussions that might be open-ended. Use the
9+
[github issue tracker](http://github.com/jgm/commonmark.js/issues)
10+
only for simple, clear, actionable issues.
11+
12+
Submitting pull requests
13+
------------------------
14+
15+
1. A good pull request makes one logical change and does not mix
16+
several independent changes.
17+
2. If you have several commits that successively refine a single
18+
logical change, rebase them into a single clean commit.
19+
3. Ensure that all tests pass (`make test`).
20+
4. Use `make lint` to check for problems.
21+
5. Ensure that performance has not been affected (`make bench` before
22+
and after the change).
23+
6. Changes to `dist` should not be committed. (We will regenerate
24+
`dist/commonmark.js` before a release.)
25+
7. Follow the style of the existing code.

0 commit comments

Comments
 (0)