Conversation
MakisH
left a comment
There was a problem hiding this comment.
Good point, we need something. But it should be as short as possible (regular contributors often complain about such checklists), and this currently includes a few points that don't apply.
What is mainly missing and would be very helpful here would be a declaration of AI tools used. I would like to make sure that a human is always in control of the work contributed.
Any suggestions in this direction?
.github/pull_request_template.md
Outdated
| ## Type of change | ||
| <!-- Please delete options that are not relevant. --> | ||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature or content (non-breaking change which adds functionality/content) | ||
| - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
| - [ ] This change requires a documentation update |
There was a problem hiding this comment.
Since checklists show up as things to do, I would not use a checklist here. It also does not really help, a maintainer would add labels accordingly.
Let's rather remove:
| ## Type of change | |
| <!-- Please delete options that are not relevant. --> | |
| - [ ] Bug fix (non-breaking change which fixes an issue) | |
| - [ ] New feature or content (non-breaking change which adds functionality/content) | |
| - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | |
| - [ ] This change requires a documentation update |
.github/pull_request_template.md
Outdated
| - [ ] This change requires a documentation update | ||
|
|
||
| ## Checklist: | ||
| - [ ] My code/content follows the style guidelines of this project |
There was a problem hiding this comment.
This is rather unclear, as we don't have such clear guidelines in this repo.
| - [ ] My code/content follows the style guidelines of this project |
.github/pull_request_template.md
Outdated
| - [ ] My code/content follows the style guidelines of this project | ||
| - [ ] I have performed a self-review of my own code/content | ||
| - [ ] I have commented my code/content, particularly in hard-to-understand areas | ||
| - [ ] I have made corresponding changes to the documentation |
There was a problem hiding this comment.
This is pretty much the documentation itself, I don't think this point needs to be explicit.
| - [ ] I have made corresponding changes to the documentation |
.github/pull_request_template.md
Outdated
| - [ ] I have performed a self-review of my own code/content | ||
| - [ ] I have commented my code/content, particularly in hard-to-understand areas | ||
| - [ ] I have made corresponding changes to the documentation | ||
| - [ ] My changes generate no new warnings |
There was a problem hiding this comment.
A bit vague. Given that the website includes both content and technicalities, more useful would be a list of common checks for technical contributions. Not sure what these would be, though, and I would only include the absolutely necessary ones.
7305c76 to
75512f0
Compare
75512f0 to
98eb2dc
Compare
|
Thanks a lot for the feedback ,@MakisH
|
|
Thanks! There are a few points here that need further discussion, I will come back to you. |
|
Thank you again for your review, @MakisH. |
|
|
||
| ## Policy on AI-generated content | ||
|
|
||
| We welcome the use of AI tools (e.g., ChatGPT, Copilot, Gemini) to help you contribute. |
There was a problem hiding this comment.
do we absolutely need to mention the names of the AI tools here?
There was a problem hiding this comment.
lets add a Screenshot section as an optional section for any UI related changes. It can also include Before and After comparison views maybe.
|
@praaatap hey! I added some comments. Hope they help make this PR even better! |
Description
Added a comprehensive Pull Request template (
.github/pull_request_template.md) to standardise PR submissions and ensure contributors follow community guidelines.The template includes:
precicerepositories.Fixes # N/A
Type of change
Checklist: