Skip to content
This repository was archived by the owner on Jul 16, 2023. It is now read-only.

Commit 172d6f8

Browse files
authored
chore: improve PR template (#1177)
* chore: update issue templates * chore: update PR template * chore: update PR template
1 parent 088bf05 commit 172d6f8

File tree

4 files changed

+33
-21
lines changed

4 files changed

+33
-21
lines changed

.github/ISSUE_TEMPLATE/new-rule.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: "New rule proposal"
2-
description: "Propose a new rule."
2+
description: "Propose a new rule"
33
title: "[New rule] (fill in)"
44
assignees: incendial
55
labels:

.github/ISSUE_TEMPLATE/question.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: "Ask a Question, Discuss"
2-
description: "Get help using DCM."
2+
description: "Get help using DCM"
33
title: "[Question] (fill in)"
44
assignees: incendial
55
labels:

.github/ISSUE_TEMPLATE/rule-change.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: "Request a rule change"
2-
description: "Request a change to an existing rule."
2+
description: "Request a change to an existing rule"
33
title: "[Rule change] (fill in)"
44
assignees: incendial
55
labels:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,40 @@
22
Thank you for contributing!
33
-->
44

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.
68

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.
1511

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+
---
1927

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>
2031
<!--
21-
Please ensure your pull request is ready:
2232
23-
- Include tests for this change
24-
- Update documentation for this change
25-
-->
33+
## Rule documentation
34+
35+
### Config example (if applicable)
2636
27-
### What changes did you make? (Give an overview)
37+
### Good example
2838
29-
### Is there anything you'd like reviewers to focus on?
39+
### Bad example
40+
41+
-->

0 commit comments

Comments
 (0)