-
-
Notifications
You must be signed in to change notification settings - Fork 77
Pull Request Template
Mai edited this page Feb 25, 2025
·
1 revision
Pull Request Template To maintain consistency, use the following template when creating a PR:
## Description
Please include a summary of the changes and the related issues.
## Related Issue
- Issue Number: #
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Refactoring
- [ ] Documentation update
## Acceptance Criteria
- [ ] Criterion 1
- [ ] Criterion 2
- [ ] Criterion 3
## New Environment Variables or Requirements
Any newly introduced dependencies or system requirements, as well as new or changed environment variables, should be described here. Do not include API keys or other sensitive environment variable values.
## How to test
Please describe the steps on how to test this PR.
## Deployment Notes (if applicable)
Please note any additional deployment steps needed, like adjusting the .env file or installing new libraries
## Screenshots (if applicable)
Add relevant screenshots to explain visual changes.
## Checklist
- [ ] I have performed a self-review of my code.
- [ ] My code follows the style guidelines of this project.
- [ ] I have commented my code where necessary.
- [ ] I have tested my code locally and verified the website is working as expected.
- [ ] (if applicable) I have added documentation in the README.
- [ ] (if applicable) I have added tests that prove my fix is effective or that my feature works.
- [ ] (if applicable) New and existing unit tests pass locally with my changes.