Connect, collaborate, and grow with a community of TypeScript developers
docs: Updates CONTRIBUTING.md to reference new PR Templates (#608)
Jim Burbridge7b48982df1ef
diff --git a/.github/PULL_REQUEST_TEMPLATE/other.md b/.github/PULL_REQUEST_TEMPLATE/other.mdnew file mode 100644index 00000000..bce33764--- /dev/null+++ b/.github/PULL_REQUEST_TEMPLATE/other.md@@ -0,0 +1,17 @@+# Non-UI Pull Request++## Basic Info++<!-- "web", "admin", "ui", etc. -->+**Package**:+<!-- Please include at least 1 ticket number which this pull request addresses -->+**Closes/References**:++## Notes++<!-- Any notes about how the change was implemented that would be relevant to the reviewer -->++## Other Relevant Info++<!-- Any other information that does not necessarily belong to any other section? -->+diff --git a/.github/PULL_REQUEST_TEMPLATE/ui.md b/.github/PULL_REQUEST_TEMPLATE/ui.mdnew file mode 100644index 00000000..df4e3bfb--- /dev/null+++ b/.github/PULL_REQUEST_TEMPLATE/ui.md@@ -0,0 +1,28 @@+# UI-Based Pull Request+++## Basic Info+<!-- "web", "admin", "ui", etc. -->+**UI Package**:+<!-- What URL does someone need to go to in order to view these changes?, e.g. "/challenge/10" or "/settings". For the UI package, include a URL that utilizes the modified component(s) -->+**UI URL**:+<!-- Please include at least 1 ticket which this pull request addresses -->+**Closes/References**:++## Notes++<!-- Any notes about how these changes were handled -->++## Screenshots++<!-- Please include any relevant screenshots. Below are some quick examples. PLEASE MAKE SURE TO UPDATE THESE. -->+++**Before**++++**After**+++diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 04e34445..ab4cab51 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -23,6 +23,15 @@ behavior to <[email protected]>> of the content, that you have the necessary rights to the content and that the> content you contribute may be provided under the project's license.+**NOTE:** For UI-based pull requests please use the+[UI Pull Request Template](.github/PULL_REQUEST_TEMPLATE/ui.md), and ensure that+you attach some screen shots to show any reviewers your changes. Reviewers are+not always able to pull down changes directly, and seeing the changes in+screenshots can serve as a good starting point for a reviewer to determine+whether or not the code needs to be pulled down and examined more closely.++For non-UI Pull Requests, please utilize the [Other](.github/PULL_REQUEST_TEMPLATE/other.md) template when creating your PR. Please be as thorough as possible.+### Reporting Bugs#### Before Submitting a Bug Report@@ -82,7 +91,8 @@ the community to understand your suggestion and find related suggestions.Enhancement suggestions are tracked as [GitHub issues](/issues).-- Use a **clear and descriptive title** for the issue to identify the suggestion.+- Use a **clear and descriptive title** for the issue to identify the+ suggestion.- Provide a **step-by-step description of the suggested enhancement** in as muchdetail as possible.- **Describe the current behavior** and **explain which behavior you expected to