Skip to content

Commit

Permalink
Add a simple pull request template.
Browse files Browse the repository at this point in the history
  • Loading branch information
kdmccormick committed Sep 13, 2019
1 parent 4957b98 commit 6c89f61
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 6c89f61

Please sign in to comment.