Add guidelines for AI usage, in PR and issue templates - #391
Add guidelines for AI usage, in PR and issue templates#391Priyankasaggu11929 wants to merge 3 commits into
Conversation
✅ Deploy Preview for node-readiness-controller canceled.
|
|
@Priyankasaggu11929 Thank you for sending this out. I'll go through this soon |
ab29421 to
8d5e8ae
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Priyankasaggu11929 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
a746602 to
b070fb0
Compare
|
I cannot decide what's better, having these in the issue/PR templates or contributing.md? The latter feels like the right shape for these guidelines. Maybe add the guidelines to contributing.md and refer it here with a checkbox? It'd also be a good idea to update the AGENTS.md with this context, so if someone is using AI tools, this could help establish the responsibility split as well!? |
+1. Adding it to CONTRIBUTING.md and AGENTS.md makes sense. (k/k also adopted a snippet yesterday). But I still think - atleast in 2 places where our most AI spam contributions are coming from (PR template and bug issue template), it makes sense to keep it as a upfront text. I will send an update later during the day. |
Thanks @Priyankasaggu11929! My only concerns were that if we overly put text into the templates, people wont read it, or start asking AI to do it. So felt keeping brief references may be better (That's with hoping people would follow redirections!). May be we could try it and see how it goes. /lgtm |
sorry, I forgot to add this ^. will address it.
In that case, I'll just keep the PR template text, and move all issues template ones to a link redirecting to CONTRIBUTING.md will send updates! |
b070fb0 to
4302a00
Compare
|
New changes are detected. LGTM label has been removed. |
Took inspiration from https://github.com/kubernetes-sigs/gwctl/blob/409ef094d221d2ac1315e4a8766ccba6302f72b6/.github/PULL_REQUEST_TEMPLATE.md?plain=1#L35C1-L53C141
/assign @ajaysundark