From ea9736688a41bf7ea12d8089ed8aae245e0e046a Mon Sep 17 00:00:00 2001 From: Hampton Maxwell Date: Sun, 7 Oct 2018 17:01:48 -0700 Subject: [PATCH] Create PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..a45a4d86 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ +Thanks for opening a PR! +Since this is a volunteer project and is very active, anything you can do to reduce the amount of time needed to review and merge your PR is appreciated. +The following steps will help get your PR merged quickly: + +#### Update the documentation +If you've added new functionality, update the README.md with an entry for your prop or event. +The entry should be inserted in alphabetical order. + +#### Update the changelog +After you open the PR, update the CHANGELOG.md file with an entry pointing to your PR. + +#### Provide an example of how to test the change +If the PR requires special testing setup provide all the relevant instructions and files. This may include a sample video file or URL, configuration, or setup steps. + +#### Focused the PR on only one area +Testing multiple features takes longer than isolated changes and if there is a bug in one feature, prevents the other parts of your PR from getting merged until it gets fixed. +If you're touching multiple different areas that aren't related, break the changes up into multiple PRs.