Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
E
edx-platform-release
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
1
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Package Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Hsin-Yu Chien
edx-platform-release
Commits
6c89f617
Commit
6c89f617
authored
5 years ago
by
Kyle McCormick
Committed by
Kyle McCormick
5 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Add a simple pull request template.
parent
4957b981
Loading
Loading
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
.github/PULL_REQUEST_TEMPLATE.md
+18
-0
18 additions, 0 deletions
.github/PULL_REQUEST_TEMPLATE.md
with
18 additions
and
0 deletions
.github/PULL_REQUEST_TEMPLATE.md
0 → 100644
+
18
−
0
View file @
6c89f617
### 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
)
.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment