harness-drone/.github/pull_request_template.md
2021-07-20 16:31:45 +01:00

1 KiB

Commit Checklist

Thank you for creating a pull request !! to help us review / merge this can you make sure that your PR adheres as much as possible to the following.

The Basics

  • my commit is a single logical unit of work, only use multiple commits if doing different tasks
  • my commit does not include commented out code or unneeded files
  • rebase of main branch

The Content

  • my commit includes tests for the bug I fixed or feature I added
  • my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality
  • my code passes existing test suites

The Commit Message

  • short description is meaningful
  • uses the imperative, present tense: "change", not "changed" or "changes"
  • includes motivation for the change, and contrasts its implementation with the previous behavior

The Pull Request

  • why, what is the reason for this change
  • example usage of the failure for a bug, or configuration and expected output for a feature