jrnl/.github/PULL_REQUEST_TEMPLATE.md
2020-04-11 11:01:51 -06:00

1.1 KiB

TEMPLATE PLEASE EDIT

Thank you for wanting to contribute! Please fill out this description as well as look at the checklist!

*Short block of text containing:

  • Relevant changes in text form
  • related issues
  • Motivation (if applicable)
  • Example of usage (if applicable)
  • Example of changes to config files (if applicable)

Checklist

  • The code change is tested and works locally.
  • Tests pass. Your PR cannot be merged unless tests pass.
  • The code passes linting via black (consistent code styling) -- black --check . --verbose --diff
  • The code passes linting via pyflakes (logically errors and unused imports) -- pyflakes .
  • There is no commented out code in this PR.
  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?