diff --git a/.github/ISSUE_TEMPLATE/new-rule.yml b/.github/ISSUE_TEMPLATE/new-rule.yml index 00757587df..e34f50a7c9 100644 --- a/.github/ISSUE_TEMPLATE/new-rule.yml +++ b/.github/ISSUE_TEMPLATE/new-rule.yml @@ -1,5 +1,5 @@ name: "New rule proposal" -description: "Propose a new rule." +description: "Propose a new rule" title: "[New rule] (fill in)" assignees: incendial labels: diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 8d9da8ce22..5e9d020a69 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,5 +1,5 @@ name: "Ask a Question, Discuss" -description: "Get help using DCM." +description: "Get help using DCM" title: "[Question] (fill in)" assignees: incendial labels: diff --git a/.github/ISSUE_TEMPLATE/rule-change.yml b/.github/ISSUE_TEMPLATE/rule-change.yml index 079faf570a..2d7407ba93 100644 --- a/.github/ISSUE_TEMPLATE/rule-change.yml +++ b/.github/ISSUE_TEMPLATE/rule-change.yml @@ -1,5 +1,5 @@ name: "Request a rule change" -description: "Request a change to an existing rule." +description: "Request a change to an existing rule" title: "[Rule change] (fill in)" assignees: incendial labels: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c536eb9fd2..8f0c6f4d49 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,28 +2,40 @@ Thank you for contributing! --> -### What is the purpose of this pull request? (put an "X" next to an item) +If your PR fixes an issue, you can add `#issue_number` into this +PR description. Please don't reference the issue with `closes` (or other) syntax +since we close the issues only after the code is released. -- [ ] Documentation update -- [ ] Bug fix -- [ ] New rule -- [ ] Changes an existing rule -- [ ] Add autofixing to a rule -- [ ] Add a CLI option -- [ ] Add something to the core -- [ ] Other, please explain: +If you added a new lint rule, here's a checklist for things that will be +checked during review or continuous integration. - +- \[ ] Red the [contributing guidelines](https://github.com/dart-code-checker/dart-code-metrics/blob/master/CONTRIBUTING.md). +- \[ ] Followed lint naming conventions +- \[ ] Tests pass locally +- \[ ] Updated the changelog +- \[ ] Added the docs to this PR + +Note that you can skip the above if you are just opening a WIP PR in +order to get feedback. + +Since the website was moved out from this repo, please add the rule documentation in the description. +Refer to [this documentation](https://dcm.dev/docs/individuals/rules/common/format-comment/) as an example. + +Delete this line and everything above before opening your PR. + +--- +# Please write a short comment explaining your change (or "none" for internal only changes) + + +## Rule documentation + +### Config example (if applicable) -### What changes did you make? (Give an overview) +### Good example -### Is there anything you'd like reviewers to focus on? +### Bad example + +-->