paperless-ngx/.github/PULL_REQUEST_TEMPLATE.md
2022-03-13 01:15:15 -08:00

1.5 KiB

Description

Please include a summary of the change and which issue is fixed (if any) and any relevant motivation / context. List any dependencies that are required for this change. Screenshots and / or videos can also be helpful if appropriate.

Fixes # (issue)

Please also tag the relevant team to help with review. You can tag any of the following: @paperless-ngx/backend (Python / django, database, etc.) @paperless-ngx/frontend (JavaScript/Typescript, HTML, CSS, etc.) @paperless-ngx/ci-cd (GitHub Actions, deployment) @paperless-ngx/test (General testing for larger PRs)

Type of change

  • 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)

Checklist:

  • I have read & agree with the contributing guidelines.
  • If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
  • If applicable, I have checked that all tests pass, see documentation.
  • I have run all pre-commit hooks, see documentation.
  • I have made corresponding changes to the documentation as needed.
  • I have checked my modifications for any breaking changes.