Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 2.06 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

47 lines (36 loc) · 2.06 KB

Description

Type of Change

  • 📚 Documentation (Non-breaking change; Changes in the documentation)
  • 🔧 Bug fix (Non-breaking change; Fixes an existing bug)
  • 🥂 Improvement (Non-breaking change; Improves existing feature)
  • 🚀 New feature (Non-breaking change; Adds functionality)
  • 🔐 Security fix (Non-breaking change; Patches a security issue)
  • 💥 Breaking change (Breaks existing functionality)

Checklist

  • I've read the [Code of Conduct](../blob/{{ cookiecutter.base_branch }}/CODE_OF_CONDUCT.md) and this pull request adheres to it.
  • I've read the [CONTRIBUTING.md](../blob/{{ cookiecutter.base_branch }}/CONTRIBUTING.md) guide.
  • I've run the complete test-suite using make test-suite, and it passed with no errors.
  • I've written new tests for all changes introduced in this pull request (where applicable).
  • I've documented any new methods/structures/packages added.

Review Process

Reviewees:

  1. Prefer incremental and appropriately-scoped changes.
  2. Leave a comment on things you want explicit feedback on.
  3. Respond clearly to comments and questions.

Reviewers:

  1. Test functionality using the criteria above.
  2. Offer tips for efficiency, feedback on best practices, and possible alternative approaches.
  3. For shorter, "quick" PRs, use your best judgment on the previous point.
  4. Use a collaborative approach and provide resources and/or context where appropriate.
  5. Provide screenshots/grabs where appropriate to show findings during review.
  6. In case of a potential bug in PR, be sure to add steps to reproduce the issue (where applicable)