From 7bb7f0159d95ef708649e8d6d625b162216752ea Mon Sep 17 00:00:00 2001 From: cpojer Date: Wed, 30 Jan 2019 08:28:01 -0800 Subject: [PATCH] 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: https://github.com/facebook/react-native/pull/23187 Differential Revision: D13877752 Pulled By: cpojer fbshipit-source-id: 8ed88cde9151a41931848cccc669208cabe1e9ef --- .github/ISSUE_TEMPLATE.md | 3 ++- .github/PULL_REQUEST_TEMPLATE.md | 17 ++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index b6468a065ae..3a342453133 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,3 +1,4 @@ -Please use one of the provided templates: +👉 Please follow one of these issue templates: - https://github.com/facebook/react-native/issues/new/choose +Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f6e97493a62..25f56477f52 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,15 @@ -Thank you for sending the PR! We appreciate you spending the time to work on these changes. -Help us understand your motivation by explaining why you decided to make this change: + +## Summary -Changelog: ----------- + -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. +## Changelog + + [CATEGORY] [TYPE] - Message +## Test Plan -Test Plan: ----------- - -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. +