From 6c89f617709e6dde8ba7da1923fb1136d0a02930 Mon Sep 17 00:00:00 2001 From: Kyle McCormick Date: Thu, 12 Sep 2019 17:03:26 -0400 Subject: [PATCH] Add a simple pull request template. --- .github/PULL_REQUEST_TEMPLATE.md | 18 ++++++++++++++++++ 1 file changed, 18 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 00000000000..5ee0fa36610 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +### Please consider the following when opening a pull request: + +- Link to the relevant JIRA ticket(s) and tag any relevant team(s). +- Squash your changes down into one or more discrete commits. + In each commit, include description that could help a developer + several months from now. +- If running `make upgrade`, run _as close to the time of merging as possible_ + to avoid accidentally downgrading someone else's package. + Put the output of `make upgrade` in its own separate commit, + decoupled from other code changes. +- Aim for comprehensive test coverage, but remember that + automated testing isn't a substitute for manual verification. +- Carefully consider naming, code organization, dependencies when adding new code. + Code that is amenable to refactoring and improvement benefits all platform developers, + especially given the size and scope of edx-platform. + Consult existing Architectural Decision Records (ADRs), + including those concerning the app(s) you are changing and + [those concerning edx-platform as a whole](https://github.com/edx/edx-platform/tree/master/docs/decisions).