Skip to content

Commit 81be774

Browse files
authored
Update contributing guidelines and the PR template (#9700)
1 parent 7a26df3 commit 81be774

2 files changed

Lines changed: 40 additions & 6 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,46 @@
1-
*Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.*
2-
31
*List which issues are fixed by this PR.*
42

5-
*Please add a note to `packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md` if your change requires release notes. Otherwise, add the 'release-notes-not-required' label to the PR.*
3+
*Replace this paragraph with a description of what this PR is changing or adding, and why. If your PR is updating any UI functionality, please include include before/after screenshots and/or a gif of the UI interaction.*
64

75
## Pre-launch Checklist
86

7+
### General checklist
8+
99
- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
1010
- [ ] I read the [Tree Hygiene] wiki page, which explains my responsibilities.
1111
- [ ] I read the [Flutter Style Guide] _recently_, and have followed its advice.
1212
- [ ] I signed the [CLA].
13-
- [ ] I listed at least one issue that this PR fixes in the description above.
1413
- [ ] I updated/added relevant documentation (doc comments with `///`).
15-
- [ ] I added new tests to check the change I am making, or there is a reason for not adding tests.
1614

15+
### Issues checklist
16+
17+
- [ ] I listed at least one issue that this PR fixes in the description above.
18+
- [ ] I listed at least one issue which has the [`contributions-welcome`] or [`good-first-issue`] label.
19+
- [ ] I did not list at least one issue with the [`contributions-welcome`] or [`good-first-issue`] label. I understand this means my PR might take longer to be reviewed.
20+
21+
### Tests checklist
22+
23+
- [ ] I added new tests to check the change I am making...
24+
- [ ] OR there is a reason for not adding tests, which I explained in the PR description.
25+
26+
### AI-tooling checklist
27+
28+
- [ ] I did not use any AI tooling in creating this PR.
29+
- [ ] OR I did use AI tooling, and...
30+
* [ ] I read the [AI contributions guidelines] and agree to follow them.
31+
* [ ] I reviewed all AI-generated code before opening this PR.
32+
* [ ] I understand and am able to discuss the code in this PR.
33+
* [ ] I have verifed the accuracy of any AI-generated text included in the PR description.
34+
* [ ] I commit to verifying the accuracy of any AI-generated code or text that I upload in response to review comments.
35+
36+
### Feature-change checklist
37+
38+
- [ ] This PR does not change the DevTools UI or behavior and...
39+
* [ ] I added the `release-notes-not-required` label or left a comment requesting the label be added.
40+
- [ ] OR this PR does change the DevTools UI or behavior and...
41+
* [ ] I added an entry to `packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md`.
42+
* [ ] I included before/after screenshots and/or a GIF demo of the new UI to my PR description.
43+
* [ ] I ran the DevTools app locally to manually verify my changes.
1744

1845
![build.yaml badge]
1946

@@ -24,5 +51,8 @@ If you need help, consider asking for help on [Discord].
2451
[Tree Hygiene]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md
2552
[Flutter Style Guide]: https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md
2653
[CLA]: https://cla.developers.google.com/
27-
[Discord]: https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md
54+
[`contributions-welcome`]: https://github.com/flutter/devtools/issues?q=state%3Aopen%20label%3Acontributions-welcome
55+
[`good-first-issue`]: https://github.com/flutter/devtools/issues?q=state%3Aopen%20label%3Agood-first-issue
56+
[AI contributions guideline]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines
2857
[build.yaml badge]: https://github.com/flutter/devtools/actions/workflows/build.yaml/badge.svg
58+
[Discord]: https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ We gladly accept contributions via GitHub pull requests! We encourage you to rea
2222
framework's contributing guide, as all of that information applies to contributing to the `flutter/devtools`
2323
repo as well.
2424

25+
We prioritize reviewing PRs that address issues with the following labels:
26+
* [`good-first-issue`](https://github.com/flutter/devtools/issues?q=state%3Aopen%20label%3Agood-first-issue): Small and easy issues that can be tackled by a first-time contributor.
27+
* [`contributions-welcome`](https://github.com/flutter/devtools/issues?q=state%3Aopen%20label%3Acontributions-welcome): Issues of any size or difficulty that we consider high-priority fixes.
28+
2529
We communicate primarily over GitHub and [Discord](https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md) on the
2630
[#hackers-devtools](https://discord.com/channels/608014603317936148/1106667330093723668) channel.
2731

0 commit comments

Comments
 (0)