Make PR template consistent with Changelog

In the new changelog format, we're following [Keep a Changelog](https://keepachangelog.com/en/1.0.0). This change updates the PR template to follow their change types, plus it simplifies the *CATEGORY* field to follow the changelog's groupings. Some simplified examples have been provided, though I plan to revisit this after 0.58 to add real-world examples. This change is motivated by react-native-community/releases#47.
turnrye · Nov 4, 2018 · 8c12abb · 8c12abb
1 parent 01b7c48
commit 8c12abb
Showing 1 changed file with 31 additions and 25 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -9,31 +9,37 @@ Test Plan:
 ----------
 Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!
 
-Release Notes:
---------------
-Help reviewers and the release process by writing your own release notes. See below for an example.
+Changelog:
+----------
+Help reviewers and the release process by writing your own changelog entry. When the change doesn't impact React Native developers, it may be ommitted from the changelog for brevity. See below for an example.
 
-[CATEGORY] [TYPE] [LOCATION] - Message
+[TYPE] [CATEGORY] - Message
 
 <!--
-  **INTERNAL and MINOR tagged notes will not be included in the next version's final release notes.**
-
-    CATEGORY
-  [----------]      TYPE
-  [ CLI      ] [-------------]    LOCATION
-  [ DOCS     ] [ BREAKING    ] [-------------]
-  [ GENERAL  ] [ BUGFIX      ] [ {Component} ]
-  [ INTERNAL ] [ ENHANCEMENT ] [ {Filename}  ]
-  [ IOS      ] [ FEATURE     ] [ {Directory} ]   |-----------|
-  [ ANDROID  ] [ MINOR       ] [ {Framework} ] - | {Message} |
-  [----------] [-------------] [-------------]   |-----------|
-
- EXAMPLES:
-
- [IOS] [BREAKING] [FlatList] - Change a thing that breaks other things
- [ANDROID] [BUGFIX] [TextInput] - Did a thing to TextInput
- [CLI] [FEATURE] [local-cli/info/info.js] - CLI easier to do things with
- [DOCS] [BUGFIX] [GettingStarted.md] - Accidentally a thing/word
- [GENERAL] [ENHANCEMENT] [Yoga] - Added new yoga thing/position
- [INTERNAL] [FEATURE] [./scripts] - Added thing to script that nobody will see
--->
+
+  CATEGORY may be:
+
+  - [General]
+  - [iOS]
+  - [Android]
+
+  TYPE may be:
+
+  - [Added] for new features.
+  - [Changed] for changes in existing functionality.
+  - [Deprecated] for soon-to-be removed features.
+  - [Removed] for now removed features.
+  - [Fixed] for any bug fixes.
+  - [Security] in case of vulnerabilities.
+
+  For more detail, see https://keepachangelog.com/en/1.0.0/#how
+
+  MESSAGE may answer "what and why" on a feature level. Use this to briefly tell React Native users about notable changes.
+
+  EXAMPLES:
+
+  [Added] [General] - Add snapToOffsets prop to ScrollView component
+  [Fixed] [General] - Fix various issues in snapToInterval on ScrollView component
+  [Fixed] [iOS] - Fix crash in RCTImagePicker
+
+-->