docs: require screenshot/video for documentation PRs#6882
docs: require screenshot/video for documentation PRs#6882tanupriyasingh1 wants to merge 2 commits into
Conversation
Signed-off-by: tanupriyasingh1 <tanuwu101@gmail.com>
rahulshendre
added
area/docs
kind/enhancement
| If AI tools were used to assist this PR: | ||
| - You must have personally reviewed, tested, and understood all changes before submitting | ||
| - Disclose AI usage in the PR description | ||
| - Do not list AI tools as co-authors in commits | ||
| - PRs that appear untested or unreviewed may be closed without review --> |
There was a problem hiding this comment.
should have AI disclosure in our PR template 👀
@Ayushmore1214, @mohammedfirdouss, @armistcxy what do you folks thing
There was a problem hiding this comment.
IMO, these looks like rules and should be put in the guidance, not in the PR template
Reference: https://github.com/kubernetes/community/blob/main/contributors/guide/pull-requests.md#ai-guidance
There was a problem hiding this comment.
thanks for the suggestion @armistcxy, yes this is already being worked on in a another PR
There was a problem hiding this comment.
@tanupriyasingh1 plz take a look here whenever you have time!
There was a problem hiding this comment.
should have AI disclosure in our PR template 👀 @Ayushmore1214, @mohammedfirdouss, @armistcxy what do you folks thing
not in PR template but guidelines in a MD file for example.
There was a problem hiding this comment.
@mohammedfirdouss yes this is already being wokred on here #6815 do take a look if you have some time thanks!
|
|
||
| **Screenshots/Videos (for documentation or website changes)**: | ||
|
|
||
| <!-- If your PR modifies files under docs/ or any .md/.mdx files: |
There was a problem hiding this comment.
@tanupriyasingh1 one question: why is this comment required here ?
| If AI tools were used to assist this PR: | ||
| - You must have personally reviewed, tested, and understood all changes before submitting | ||
| - Disclose AI usage in the PR description | ||
| - Do not list AI tools as co-authors in commits | ||
| - PRs that appear untested or unreviewed may be closed without review --> |
There was a problem hiding this comment.
thanks for the suggestion @armistcxy, yes this is already being worked on in a another PR
| If AI tools were used to assist this PR: | ||
| - You must have personally reviewed, tested, and understood all changes before submitting | ||
| - Disclose AI usage in the PR description | ||
| - Do not list AI tools as co-authors in commits | ||
| - PRs that appear untested or unreviewed may be closed without review --> |
There was a problem hiding this comment.
@tanupriyasingh1 plz take a look here whenever you have time!
|
@rahulshendre This is one of the reason why I advocate your idea of using Netlify. It supports preview document changes and we no longer need additional require for PR template |
|
Hey @Ayushmore1214! The comment block was meant to provide hidden guidance to contributors, but I agree it's not the right approach since it hides all the useful content beneath the heading. I'll replace it with a simple visible instruction line instead. Thanks for pointing that out! |
|
Removing the AI disclosure section from this PR since it's already being handled in #6815. Will also simplify the screenshots comment block into a clean visible instruction. Will push the updated commit shortly |
Agreed, Netlify preview deploys would make this unnecessary long-term. Until then, the screenshots section is a good interim measure. |
tanupriyasingh1
force-pushed
the
require-screenshot-docs
branch
from
aca84ed to
ffc0cb0
Compare
|
hey @rahulshendre I've pushed the updated changes. PTAL whenever you have time |
Ayushmore1214
left a comment
Ayushmore1214
left a comment
There was a problem hiding this comment.
Thanks @tanupriyasingh1
rahulshendre
left a comment
rahulshendre
left a comment
There was a problem hiding this comment.
LGTM
Thanks @tanupriyasingh1 🙌
5 participants
What this PR does:
Updates the PR template to add a screenshots/videos section for documentation and website changes, along with a note on AI-assisted contributions.
Why we need it:
Doc changes were being submitted without local verification, especially with the rise of AI tools among contributors. This ensures contributors have actually run and tested their changes locally before submitting, and gives reviewers a quick visual check.
Which issue(s) this PR fixes:
Fixes #6752
Does this PR introduce a user-facing change?: