|
2 | 2 | Thank you for contributing!
|
3 | 3 | -->
|
4 | 4 |
|
5 |
| -### What is the purpose of this pull request? (put an "X" next to an item) |
| 5 | +If your PR fixes an issue, you can add `#issue_number` into this |
| 6 | +PR description. Please don't reference the issue with `closes` (or other) syntax |
| 7 | +since we close the issues only after the code is released. |
6 | 8 |
|
7 |
| -- [ ] Documentation update |
8 |
| -- [ ] Bug fix |
9 |
| -- [ ] New rule |
10 |
| -- [ ] Changes an existing rule |
11 |
| -- [ ] Add autofixing to a rule |
12 |
| -- [ ] Add a CLI option |
13 |
| -- [ ] Add something to the core |
14 |
| -- [ ] Other, please explain: |
| 9 | +If you added a new lint rule, here's a checklist for things that will be |
| 10 | +checked during review or continuous integration. |
15 | 11 |
|
16 |
| -<!-- |
17 |
| - If this pull request is addressing an issue, please paste a link to the issue here. |
18 |
| ---> |
| 12 | +- \[ ] Red the [contributing guidelines](https://github.com/dart-code-checker/dart-code-metrics/blob/master/CONTRIBUTING.md). |
| 13 | +- \[ ] Followed lint naming conventions |
| 14 | +- \[ ] Tests pass locally |
| 15 | +- \[ ] Updated the changelog |
| 16 | +- \[ ] Added the docs to this PR |
| 17 | + |
| 18 | +Note that you can skip the above if you are just opening a WIP PR in |
| 19 | +order to get feedback. |
| 20 | + |
| 21 | +Since the website was moved out from this repo, please add the rule documentation in the description. |
| 22 | +Refer to [this documentation](https://dcm.dev/docs/individuals/rules/common/format-comment/) as an example. |
| 23 | + |
| 24 | +Delete this line and everything above before opening your PR. |
| 25 | + |
| 26 | +--- |
19 | 27 |
|
| 28 | +# Please write a short comment explaining your change (or "none" for internal only changes) |
| 29 | + |
| 30 | +<!-- Uncomment the section below, if you the PR adds or changes a rule> |
20 | 31 | <!--
|
21 |
| - Please ensure your pull request is ready: |
22 | 32 |
|
23 |
| - - Include tests for this change |
24 |
| - - Update documentation for this change |
25 |
| ---> |
| 33 | +## Rule documentation |
| 34 | +
|
| 35 | +### Config example (if applicable) |
26 | 36 |
|
27 |
| -### What changes did you make? (Give an overview) |
| 37 | +### Good example |
28 | 38 |
|
29 |
| -### Is there anything you'd like reviewers to focus on? |
| 39 | +### Bad example |
| 40 | +
|
| 41 | +--> |
0 commit comments