Skip to content

Instantly share code, notes, and snippets.

@RomanPodkovyrin
Last active April 5, 2023 13:19
Show Gist options
  • Save RomanPodkovyrin/2e9c0b3cd7e74353051bf30f9a4352bf to your computer and use it in GitHub Desktop.
Save RomanPodkovyrin/2e9c0b3cd7e74353051bf30f9a4352bf to your computer and use it in GitHub Desktop.
pull request template

Description

Please include a summary of the changes and features. Please also include relevant motivation and context. List any dependencies that are required for this change.

URL to relevant Jira ticket

Please include the link to the relevant Jira ticket here for ease of cross-referencing.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Technical Enhancements

Checklist:

If any of these are not completed, please explain why in notes.

Definition of Done

Code and merges

  • Code review (informal/walk through (and/or produced with Pair programming)
  • Code review completed by the appropriate people (1 thumbs up)
  • Code to be commented where applicable
  • Documentation updated where required
  • Have considered non-functional requirements such as Security, Performance, Scalability and Fault Tolerance.

Testing

  • All levels of acceptance test are passing (automated, integration, manual, accessibility etc.)
  • Functional test passed
  • Acceptance criteria met

Deployment

  • Builds are green

Other Checks

  • I have performed a self-review of my own code
  • I have checked for spelling errors
  • I have commented my code, particularly in hard-to-understand areas
  • My changes don't break anything unexpected
  • Up to date with master branch

Notes:

Add any extra information that is important for the rest of the team/reviewers to know here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment