Skip to content

Commit 7bb7f01

Browse files
cpojerfacebook-github-bot
authored andcommitted
Update Pull Request and Issue templates. (#23187)
Summary: As a maintainer, I noticed that the description for a PR is often missing, which makes it hard to understand why a change is made. Because some of the text isn't using HTML comments, the same text explaining how to fill out the changelog and test plan pops up and isn't removed by people. This PR fixes both of these issues. I also made another small update to the main issue template to urge people to use one of the other templates, with an explanation that we will close poorly formatted issues. Changelog: ---------- [General] [Changed] - Updated GitHub templates Pull Request resolved: #23187 Differential Revision: D13877752 Pulled By: cpojer fbshipit-source-id: 8ed88cde9151a41931848cccc669208cabe1e9ef
1 parent 6feb3dc commit 7bb7f01

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

.github/ISSUE_TEMPLATE.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
Please use one of the provided templates:
1+
👉 Please follow one of these issue templates:
22
- https://github.com/facebook/react-native/issues/new/choose
33

4+
Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.

.github/PULL_REQUEST_TEMPLATE.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
1-
Thank you for sending the PR! We appreciate you spending the time to work on these changes.
2-
Help us understand your motivation by explaining why you decided to make this change:
1+
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please provide enough information so that others can review your pull request. The three fields below are mandatory. -->
32

3+
## Summary
44

5-
Changelog:
6-
----------
5+
<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
76

8-
Help reviewers and the release process by writing your own changelog entry. See http://facebook.github.io/react-native/docs/contributing#changelog for an example.
7+
## Changelog
98

10-
[CATEGORY] [TYPE] - Message
9+
<!-- Help reviewers and the release process by writing your own changelog entry. See http://facebook.github.io/react-native/docs/contributing#changelog for an example. -->
1110

11+
[CATEGORY] [TYPE] - Message
1212

13-
Test Plan:
14-
----------
13+
## Test Plan
1514

16-
Write your test plan here (**REQUIRED**). If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos! Increase test coverage whenever possible.
15+
<!-- Write your test plan here (**REQUIRED**). Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. -->

0 commit comments

Comments
 (0)