Updated: Align "Type of changes" and "Checklist" with Pull Request template

- Updated the "Type of changes" and "Checklist" sections in CONTRIBUTING.md.
- Ensured the formatting and wording match the guidelines provided in the pull request template for consistency.

modified: CONTRIBUTING.md
This commit is contained in:
GJS 2025-04-02 09:47:15 +02:00
parent 9075f4c718
commit 6576529110
No known key found for this signature in database
GPG key ID: BE32D9EAF927E85B

View file

@ -252,25 +252,31 @@ to review the appropriate one for your contribution.
- Bugfix (a non-breaking change that resolves an issue) - Bugfix (a non-breaking change that resolves an issue)
- New feature (a non-breaking change that adds new functionality) - New feature (a non-breaking change that adds new functionality)
- Breaking change (a fix or feature that alters existing functionality in a way that could cause issues) - Breaking change (a fix or feature that alters existing functionality in a
way that could cause issues)
- User Interface (UI) updates - User Interface (UI) updates
- New Documentation (addition of new documentation) - New Documentation (addition of new documentation)
- Documentation Update (modification of existing documentation) - Documentation Update (modification of existing documentation)
- Documentation Update Required (the change requires updates to related documentation) - Documentation Update Required (the change requires updates to related
documentation)
- Other (please specify): - Other (please specify):
- Provide additional details here. - Provide additional details here.
- **Checklist** - **Checklist**
- My code adheres to the style guidelines of this project. - My code adheres to the style guidelines of this project.
- I ran code linters for modified files. - I ran ESLint and other code linters for modified files.
- I have reviewed and tested my code. - I have reviewed and tested my code.
- I have commented my code, especially in hard-to-understand areas (e.g., using JSDoc for methods). - I have commented my code, especially in hard-to-understand areas (e.g.,
using JSDoc for methods).
- My changes generate no new warnings. - My changes generate no new warnings.
- My code needed automated testing. I have added them (this is an optional task). - My code needed automated testing. I have added them (this is an optional
task).
- Documentation updates are included (if applicable). - Documentation updates are included (if applicable).
- I have considered potential security impacts and mitigated risks. - I have considered potential security impacts and mitigated risks.
- Dependency updates are listed and explained. - Dependency updates are listed and explained.
- I have read and understood the
[Pull Request guidelines](../CONTRIBUTING.md#recommended-pull-request-guideline).
10. **When publishing your PR, set it as a** `Draft pull request` **to allow 10. **When publishing your PR, set it as a** `Draft pull request` **to allow
for review and prevent automatic merging.** for review and prevent automatic merging.**
@ -380,25 +386,31 @@ early on, helping to avoid issues down the line.
- Bugfix (a non-breaking change that resolves an issue) - Bugfix (a non-breaking change that resolves an issue)
- New feature (a non-breaking change that adds new functionality) - New feature (a non-breaking change that adds new functionality)
- Breaking change (a fix or feature that alters existing functionality in a way that could cause issues) - Breaking change (a fix or feature that alters existing functionality in a
way that could cause issues)
- User Interface (UI) updates - User Interface (UI) updates
- New Documentation (addition of new documentation) - New Documentation (addition of new documentation)
- Documentation Update (modification of existing documentation) - Documentation Update (modification of existing documentation)
- Documentation Update Required (the change requires updates to related documentation) - Documentation Update Required (the change requires updates to related
documentation)
- Other (please specify): - Other (please specify):
- Provide additional details here. - Provide additional details here.
- **Checklist** - **Checklist**
- My code adheres to the style guidelines of this project. - My code adheres to the style guidelines of this project.
- I ran code linters for modified files. - I ran ESLint and other code linters for modified files.
- I have reviewed and tested my code. - I have reviewed and tested my code.
- I have commented my code, especially in hard-to-understand areas (e.g., using JSDoc for methods). - I have commented my code, especially in hard-to-understand areas (e.g.,
using JSDoc for methods).
- My changes generate no new warnings. - My changes generate no new warnings.
- My code needed automated testing. I have added them (this is an optional task). - My code needed automated testing. I have added them (this is an optional
task).
- Documentation updates are included (if applicable). - Documentation updates are included (if applicable).
- I have considered potential security impacts and mitigated risks. - I have considered potential security impacts and mitigated risks.
- Dependency updates are listed and explained. - Dependency updates are listed and explained.
- I have read and understood the
[Pull Request guidelines](../CONTRIBUTING.md#recommended-pull-request-guideline).
10. **When publishing your PR, set it as a** `Draft pull request` **to allow for 10. **When publishing your PR, set it as a** `Draft pull request` **to allow for
review and prevent automatic merging.** review and prevent automatic merging.**