|
1 | 1 | # Contributing |
| 2 | + |
2 | 3 | See [Atom's Contributing guidelines](https://atom.io/docs/latest/contributing). |
3 | 4 |
|
4 | 5 | ## Reporting an issue |
| 6 | + |
5 | 7 | Please use [GitHub's Issue Search](https://help.github.com/articles/using-search-to-filter-issues-and-pull-requests/) to help reduce the number of duplicate issues reported. |
6 | 8 | If you find an issue you're facing, feel free to comment on the open issues you're facing to raise with any details that could help debugging the problem. |
7 | 9 |
|
8 | 10 | When reporting an issue include information such as: |
9 | | -* **Reproduction steps** if possible. |
10 | | -* The Platform (Operating System) you're on. |
11 | | -* The Atom version you're running. |
12 | | -* The Script package version. |
13 | | -* The Grammar you're attempting to run. |
14 | | -* Consider adding a failing spec, with an Atom package this isn't as simple but could really help speed up debugging the issue. |
| 11 | + |
| 12 | +- **Reproduction steps** if possible. |
| 13 | +- The Platform (Operating System) you're on. |
| 14 | +- The Atom version you're running. |
| 15 | +- The Script package version. |
| 16 | +- The Grammar you're attempting to run. |
| 17 | +- Consider adding a failing spec, with an Atom package this isn't as simple but could really help speed up debugging the issue. |
15 | 18 |
|
16 | 19 | The more information available when we take a look at your issue the more likely we can deal with it in a quick manner. |
17 | 20 |
|
18 | 21 | ## Developing |
| 22 | + |
19 | 23 | We love pull requests! If you're reading this section thanks in advance. |
20 | 24 |
|
21 | 25 | To help accelerate the review process: |
22 | | -* Consider adding specs. |
23 | | - * Passing tests give reviewers confidence. |
24 | | -* Consider adding verification steps for reviewers. |
| 26 | + |
| 27 | +- Consider adding specs. |
| 28 | + - Passing tests give reviewers confidence. |
| 29 | +- Consider adding verification steps for reviewers. |
0 commit comments