flip/dcrd
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/dcrd.git synced 2026-02-06 10:56:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
893aa30dce
dcrd/.github/pull_request_template.md
Dave Collins 979d21f6f3
docs: Add github pull request template. 
This adds a pull request template which provides a checklist and links
to the code contribution guidelines to help contributors ensure they are
adhering to project standards.
2018-10-01 11:32:16 -05:00

1.4 KiB
Raw Blame History

All Submissions:

  • Submission follows the Code Contribution Guidelines
  • There are not any other open Pull Requests for the same update/change
  • Commit messages are formatted according to Model Git Commit Messages
  • All changes are compliant with the latest version of Go and the one prior to it
  • The code being submitted is commented according to the Code Documentation and Commenting section of the Code Contribution Guidelines
  • Any new logging statements use an appropriate subsystem and logging level
  • Code has been formatted with go fmt
  • Running go test does not fail any tests or report any vet issues
  • Running golint does not report any new issues that did not already exist

New Feature Submissions:

  • Code is accompanied by tests which exercise both the positive and negative (error paths) conditions (if applicable)

Bug Fixes:

  • Code is accompanied by new tests which trigger the bug being fixed to prevent regressions

Changes to Core Features:

  • An explanation of what the changes do and why they should be included is provided
  • Code is accompanied by updates to tests and/or new tests for the core changes (if applicable)