Skip to content

Instantly share code, notes, and snippets.

@timmc-edx

timmc-edx/pr-checklist.md

Last active January 27, 2021 14:14
Show Gist options
  • Save timmc-edx/03cc4bebd9d524c7cf5b7dc268f55d21 to your computer and use it in GitHub Desktop.
Save timmc-edx/03cc4bebd9d524c7cf5b7dc268f55d21 to your computer and use it in GitHub Desktop.
Download ZIP
Code review checklist, edX version
Raw
pr-checklist.md

Have the following been addressed in the branch, if appropriate?

  • Tests (unit, API, integration)
  • Docs (source comments, doc directory, elsewhere)
  • Changelog
  • Compatibility with previous versions (calls, shared files or DBs, data formats -- backward and forward compatibility)
  • Rollback friendly?
  • Feature switches?

edX-specific considerations:

  • Anything for the next-release notes on the wiki?
  • Should this be floated on Discourse or Slack to see if there are any community concerns you haven't thought of?
  • Does this PR create a large amount of code churn that will make life unnecessarily difficult for forks?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment