Skip to content

Commit b9bc2fa

Browse files
authored
Request more metadata for changelog entries to the PR template (#575)
* Include more metadata for changelog updates to PR template * Update pull_request_template.md * Pre-commit fixes
1 parent 7fb4789 commit b9bc2fa

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

.github/pull_request_template.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!--
2+
Please carefully follow the instructions of the template, as they allow for more effective reviews with fewer back-and-forth, making a smoother process for everyone.
3+
Prefer small, independent PRs over big monolithic ones when possible.
4+
If you are only looking for feedback, clearly indicate this and open it as a "draft" instead (use the green "v" button next to "create pull request").
5+
-->
6+
7+
8+
## Change(s)
9+
<!-- Briefly describe the change of this PR, if there are multiple changes, please describe them separately. -->
10+
Change Type: <!-- Added/Changed/Deprecated/Removed/Fixed/Security -->
11+
12+
Change Category: <!-- Documentation/Interface/Internal/Other -->
13+
14+
Changelog Entry: <!-- Brief description of the change, possibly followed by more details in a separate paragraph. For example: -->
15+
16+
<!--
17+
Added the `contacts` field to the `AIResource` `GET` endpoints with full contact information.
18+
19+
This field contains the full contact information of the contacts whose identifiers are currently already provided through the `contact` field.
20+
-->
21+
22+
23+
24+
## How to Test
25+
<!-- Describe a way to test the change of this PR if it requires special steps beyond CI/CD. You're writing this for the reviewer. -->
26+
27+
## Checklist
28+
- [ ] Tests have been added or updated to reflect the changes, or their absence is explicitly explained. <!-- For code changes -->
29+
- [ ] Documentation has been added or updated to reflect the changes, or their absence is explicitly explained.
30+
- [ ] A self-review has been conducted checking:
31+
- No unintended changes have been committed.
32+
- The changes in isolation seem reasonable.
33+
- Anything that may be odd or unintuitive is provided with a GitHub comment explaining it (but consider if this should not be a code comment or in the documentation instead).
34+
- [ ] All CI checks pass before pinging a reviewer, or provide an explanation if they do not.
35+
- [ ] The PR title matches the changelog entry's one-line description.
36+
37+
## Related Issues
38+
<!-- Provide a list of relevant issues and/or pull requests, if any. -->
39+
<!-- If the pull request closes and issue, specify "Closes #X" (where X is the issue number). -->

0 commit comments

Comments
 (0)