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

chore: improve PR template #1177

Merged
merged 4 commits into from
Jan 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/new-rule.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/rule-change.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
48 changes: 30 additions & 18 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!--
If this pull request is addressing an issue, please paste a link to the issue here.
-->
- \[ ] 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)

<!-- Uncomment the section below, if you the PR adds or changes a rule>
<!--
Please ensure your pull request is ready:

- Include tests for this change
- Update documentation for this change
-->
## 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

-->