|
1 | | -(Please add to the PR name the issue/s that this PR would close if merged by using a [Github](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) keyword. Example: `<feature name>. Closes #999`. If your PR is made by a single commit, please add that clause in the commit too. This is all required to automate the closure of related issues.) |
2 | | - |
3 | 1 | # Description |
4 | 2 |
|
5 | | -Please include a summary of the change. |
| 3 | +Please include a short summary of the change. Don't just paste LLM output here. |
6 | 4 |
|
7 | | -## Related issues |
8 | | -Please add related issues. |
| 5 | +### Related issues |
9 | 6 |
|
10 | | -## Type of change |
| 7 | +Please add related issues: the issues you are trying to solve as well as other issues that are important in the context of this pull request. |
11 | 8 |
|
12 | | -Please delete options that are not relevant. |
| 9 | +### Type of change |
13 | 10 |
|
14 | 11 | - [ ] Bug fix (non-breaking change which fixes an issue). |
15 | 12 | - [ ] New feature (non-breaking change which adds functionality). |
16 | 13 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected). |
| 14 | +- [ ] Chore (refactoring, dependency updates, CI/CD changes, code cleanup, docs-only changes). |
17 | 15 |
|
18 | 16 | # Checklist |
19 | 17 |
|
| 18 | +Please complete this checklist carefully. It helps guide your contribution and lets maintainers verify that all requirements are met. |
| 19 | + |
| 20 | +### Formalities |
| 21 | + |
20 | 22 | - [ ] I have read and understood the rules about [how to Contribute](https://intelowlproject.github.io/docs/GreedyBear/Contribute/) to this project. |
| 23 | +- [ ] I chose an appropriate title for the pull request in the form: `<feature name>. Closes #999` |
| 24 | +- [ ] My branch is based on `develop`. |
21 | 25 | - [ ] The pull request is for the branch `develop`. |
22 | | -- [ ] I have added documentation of the new features. |
| 26 | +- [ ] I have reviewed and verified any LLM-generated code included in this PR. |
| 27 | + |
| 28 | +### Docs and tests |
| 29 | + |
| 30 | +- [ ] I documented my code changes with docstrings and/or comments. |
| 31 | +- [ ] I have checked if my changes affect user-facing behavior that is described in the [docs](https://intelowlproject.github.io/docs/GreedyBear/Introduction/). If so, I also created a pull request in the [docs repository](https://github.com/intelowlproject/docs). |
23 | 32 | - [ ] Linter (`Ruff`) gave 0 errors. If you have correctly installed [pre-commit](https://intelowlproject.github.io/docs/GreedyBear/Contribute/#how-to-start-setup-project-and-development-instance), it does these checks and adjustments on your behalf. |
24 | | -- [ ] I have added tests for the feature/bug I solved. All the tests (new and old ones) gave 0 errors. |
25 | | -- [ ] If changes were made to an existing model/serializer/view, the docs were updated and regenerated (check [CONTRIBUTE.md](https://github.com/intelowlproject/docs/blob/main/docs/GreedyBear/Contribute.md)). |
26 | | -- [ ] If the GUI has been modified: |
27 | | - - [ ] I have a provided a screenshot of the result in the PR. |
28 | | - - [ ] I have created new frontend tests for the new component or updated existing ones. |
| 33 | +- [ ] I have added tests for the feature/bug I solved. |
| 34 | +- [ ] All the tests gave 0 errors. |
| 35 | + |
| 36 | +### GUI changes |
| 37 | + |
| 38 | +Ignore this section if you did not make any changes to the GUI. |
| 39 | + |
| 40 | +- [ ] I have provided a screenshot of the result in the PR. |
| 41 | +- [ ] I have created new frontend tests for the new component or updated existing ones. |
29 | 42 |
|
30 | | -### Important Rules |
31 | | -- If you miss to compile the Checklist properly, your PR won't be reviewed by the maintainers. |
32 | | -- If your changes decrease the overall tests coverage (you will know after the Codecov CI job is done), you should add the required tests to fix the problem |
33 | | -- Everytime you make changes to the PR and you think the work is done, you should explicitly ask for a review. After being reviewed and received a "change request", you should explicitly ask for a review again once you have made the requested changes. |
| 43 | +# Review process |
| 44 | + |
| 45 | +- We encourage you to create a draft PR first, even when your changes are incomplete. This way you refine your code while we can track your progress and actively review and help. |
| 46 | +- If you think your draft PR is ready to be reviewed by the maintainers, click the corresponding button. Your draft PR will become a real PR. |
| 47 | +- If your changes decrease the overall tests coverage (you will know after the Codecov CI job is done), you should add the required tests to fix the problem. |
| 48 | +- Every time you make changes to the PR and you think the work is done, you should explicitly ask for a review. After receiving a "change request", address the feedback and click "request re-review" next to the reviewer's profile picture at the top right. |
0 commit comments