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

Commit 7ba3ef8

Browse files
incendialincendial
committed
Merge remote-tracking branch 'origin' into clean-unused-code
2 parents cdcb67b + 755ca4f commit 7ba3ef8

File tree

213 files changed

+1231
-29572
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

213 files changed

+1231
-29572
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug Report
2+
description: Create a bug report for DCM
3+
title: "[BUG] (fill in)"
4+
assignees: incendial
5+
labels:
6+
- "type: bug"
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: Thank you for filing a bug report! 🐛
11+
- type: textarea
12+
attributes:
13+
label: Environment and configuration
14+
description: |
15+
Please tell us about how you're running DCM.
16+
value: |
17+
DCM version:
18+
Dart SDK version:
19+
20+
<details>
21+
<summary>Configuration</summary>
22+
23+
```yaml
24+
<!-- Paste your configuration here -->
25+
```
26+
</details>
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: What did you do?
32+
description: |
33+
Please include a *minimal* reproduction case. If possible, include a link to a reproduction of the problem. You can use Markdown in this field.
34+
value: |
35+
<!-- Paste the source code below: -->
36+
```dart
37+
38+
```
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: What did you expect to happen?
44+
description: |
45+
You can use Markdown in this field.
46+
validations:
47+
required: true
48+
- type: textarea
49+
attributes:
50+
label: What actually happened?
51+
description: |
52+
Please copy-paste the actual DCM output. You can use Markdown in this field.
53+
validations:
54+
required: true
55+
- type: checkboxes
56+
attributes:
57+
label: Participation
58+
options:
59+
- label: I am willing to submit a pull request for this issue.
60+
required: false
61+
- type: textarea
62+
attributes:
63+
label: Additional comments
64+
description: Is there anything else that's important for the team to know?

‎.github/ISSUE_TEMPLATE/change.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "Request a change (not rule-related)"
2+
description: "Request a change that is not a bug fix, rule change, or new rule"
3+
title: "[Change request] (fill in)"
4+
labels:
5+
- "type: enhancement"
6+
body:
7+
- type: input
8+
attributes:
9+
label: DCM version
10+
description: |
11+
What version of DCM are you currently using?
12+
placeholder: |
13+
e.g. v8.0.0
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: What problem do you want to solve?
19+
description: |
20+
Please explain your use case in as much detail as possible.
21+
placeholder: |
22+
DCM currently...
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: What do you think is the correct solution?
28+
description: |
29+
Please explain how you'd like to change DCM to address the problem.
30+
placeholder: |
31+
I'd like DCM to...
32+
validations:
33+
required: true
34+
- type: checkboxes
35+
attributes:
36+
label: Participation
37+
options:
38+
- label: I am willing to submit a pull request for this change.
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: Additional comments
43+
description: Is there anything else that's important for the team to know?

‎.github/ISSUE_TEMPLATE/new-rule-proposal.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/new-rule.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "New rule proposal"
2+
description: "Propose a new rule"
3+
title: "[New rule] (fill in)"
4+
assignees: incendial
5+
labels:
6+
- area-rules
7+
- "type: enhancement"
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: Thank you for your lint idea!
12+
- type: textarea
13+
attributes:
14+
label: Rule details
15+
description: What should the new rule do?
16+
validations:
17+
required: true
18+
- type: dropdown
19+
attributes:
20+
label: What type of rule is this?
21+
options:
22+
- Warns about a potential problem
23+
- Suggests an alternate way of doing something
24+
- Enforces a formatting/stylistic preference
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: Example code
30+
description: Please provide some example Dart code that this rule will warn about. This field will render as Dart.
31+
render: dart
32+
validations:
33+
required: true
34+
- type: checkboxes
35+
attributes:
36+
label: Participation
37+
options:
38+
- label: I am willing to submit a pull request to implement this rule.
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: Additional comments
43+
description: Is there anything else that's important for the team to know?

‎.github/ISSUE_TEMPLATE/question.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
name: "Ask a Question, Discuss"
2+
description: "Get help using DCM"
3+
title: "[Question] (fill in)"
4+
assignees: incendial
5+
labels:
6+
- "type: question"
7+
body:
8+
- type: textarea

‎.github/ISSUE_TEMPLATE/rule-change-proposal.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/rule-change.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: "Request a rule change"
2+
description: "Request a change to an existing rule"
3+
title: "[Rule change] (fill in)"
4+
assignees: incendial
5+
labels:
6+
- area-rules
7+
- "type: enhancement"
8+
body:
9+
- type: input
10+
attributes:
11+
label: What rule do you want to change?
12+
validations:
13+
required: true
14+
- type: dropdown
15+
attributes:
16+
label: What change to do you want to make?
17+
options:
18+
- Generate more warnings
19+
- Generate fewer warnings
20+
- Implement autofix
21+
- Implement suggestions
22+
validations:
23+
required: true
24+
- type: dropdown
25+
attributes:
26+
label: How do you think the change should be implemented?
27+
options:
28+
- A new option
29+
- A new default behavior
30+
- Other
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Example code
36+
description: Please provide some example code that this change will affect. This field will render as Dart.
37+
render: dart
38+
validations:
39+
required: true
40+
- type: textarea
41+
attributes:
42+
label: What does the rule currently do for this code?
43+
validations:
44+
required: true
45+
- type: textarea
46+
attributes:
47+
label: What will the rule do after it's changed?
48+
validations:
49+
required: true
50+
- type: checkboxes
51+
attributes:
52+
label: Participation
53+
options:
54+
- label: I am willing to submit a pull request to implement this change.
55+
required: false
56+
- type: textarea
57+
attributes:
58+
label: Additional comments
59+
description: Is there anything else that's important for the team to know?

‎.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)