Add Generative AI disclosure policy to contribution guidelines and PR template#3640
Add Generative AI disclosure policy to contribution guidelines and PR template#3640shlokgilda wants to merge 9 commits intochaoss:mainfrom
Conversation
… template Signed-off-by: Shlok Gilda <gildashlok@hotmail.com>
MoralCode
left a comment
There was a problem hiding this comment.
Initial first pass review - i think we can maybe also refactor the may short middle sections into a different structure ( short paragraphs?) that says the same thing but may take up less space?
Unsure. will discuss over the coming days
Overall this is a great start!
|
|
||
| ## Related issues/PRs | ||
| - This is a bulleted list of any related issues/PRs; leave blank if there are none No newline at end of file | ||
| - This is a bulleted list of any related issues/PRs; leave blank if there are none |
There was a problem hiding this comment.
we should maybe have this be a comment so that we dont have this text appearing in every PR if it is not edited
There was a problem hiding this comment.
Good call, will wrap the placeholder text in comments so it doesn't clutter PRs.
There was a problem hiding this comment.
I could wrap all placeholder texts in this file: "Changeset," "Notes," and "Related issues/PRs". Slightly out of scope of this PR but if it's okay, I can do it. LMK.
CONTRIBUTING.md
Outdated
|
|
||
| ## Generative AI Policy | ||
|
|
||
| You can use AI tools to help with your contributions. **You are the author, and you are accountable for the result.** |
There was a problem hiding this comment.
i worry that people will read this first sentence and then be like "ok cool, its allowed" and then turn their brains off and not read the rest of the policy
| You can use AI tools to help with your contributions. **You are the author, and you are accountable for the result.** | |
| We allow contributions that utilize generative AI tools provided they follow our policy of responsible AI use. This policy boils down to: **You, the author, are responsible for ensuring any contributions under your name**. These policies are primarily designed to ensure that the Augur project remains sustainable and healthy into the future. |
There was a problem hiding this comment.
I get the concern about people reading the first line and tuning out. Your version is a bit wordy though. How about something like: "You can use AI tools to help with your contributions, subject to the requirements below. You are the author, and you are accountable for the result." Keeps it concise but signals there's more to read?
Co-authored-by: Adrian Edwards <17362949+MoralCode@users.noreply.github.com> Signed-off-by: Shlok Gilda <gildashlok@hotmail.com>
Co-authored-by: Adrian Edwards <17362949+MoralCode@users.noreply.github.com> Signed-off-by: Shlok Gilda <gildashlok@hotmail.com>
Co-authored-by: Adrian Edwards <17362949+MoralCode@users.noreply.github.com> Signed-off-by: Shlok Gilda <gildashlok@hotmail.com>
|
Will look at consolidating the shorter sections once the other changes land. Might be easier to evaluate the length/structure after the content is finalized. |
Signed-off-by: Shlok Gilda <gildashlok@hotmail.com>
Consolidates the AI disclosure section into the actual default PR template (pull_request_template.md) and removes the unused PULL_REQUEST_TEMPLATE/ directory that wasn't auto-populating. Signed-off-by: Shlok Gilda <gildashlok@hotmail.com>
MoralCode
left a comment
There was a problem hiding this comment.
added some feedback since i saw there were new commits here
CONTRIBUTING.md
Outdated
|
|
||
| 1. **Disclose AI use.** Complete the AI disclosure section in the PR template. This is mandatory. If no AI was used, check the "No generative AI" box — that's a valid answer, and it helps us distinguish from incomplete templates. | ||
|
|
||
| 2. **Review before submitting.** Read and test all AI-generated code or text before asking maintainers to review it. If you can't explain why a change works, it's not ready for a maintainer to review. If your changes are too long for you to read and review, that is a good indication that they are also too long for maintainers to read. |
There was a problem hiding this comment.
maybe a better way to title this is "human in the loop"/human responsibility
CONTRIBUTING.md
Outdated
| Reviewing contributions takes real time and energy. Submitting unreviewed AI output shifts that burden onto maintainers — this is sometimes called an "extractive contribution." | ||
|
|
||
| Disclosure matters because: |
There was a problem hiding this comment.
the transition from unreviewed to undisclosed here seems strange
CONTRIBUTING.md
Outdated
|
|
||
| - **Respect.** Discovering a PR was unreviewed AI output after spending time on it feels like a waste. Telling us upfront lets us calibrate. | ||
| - **Research.** Augur measures open source community health. Understanding how AI tools are used in our own community is directly relevant to our mission. | ||
| - **Honesty.** Citing your tools is the same principle as citing Stack Overflow. It builds trust. |
There was a problem hiding this comment.
| - **Honesty.** Citing your tools is the same principle as citing Stack Overflow. It builds trust. | |
| - **Honesty.** Citing your sources is the difference between plagiarism and reusing/adapting ideas. You should cite the tools you use, whether that is Stack Overflow or an AI tool. It also helps build trust. |
|
|
||
| This applies to all contributions: code, issues, PR comments, documentation. | ||
|
|
||
| **Disclose:** code generation, test generation, documentation drafting, AI-assisted code review, substantial refactoring suggestions. | ||
|
|
There was a problem hiding this comment.
this seems a bit redundant with what has already been said above
| This applies to all contributions: code, issues, PR comments, documentation. | |
| **Disclose:** code generation, test generation, documentation drafting, AI-assisted code review, substantial refactoring suggestions. |
CONTRIBUTING.md
Outdated
|
|
||
| **Disclose:** code generation, test generation, documentation drafting, AI-assisted code review, substantial refactoring suggestions. | ||
|
|
||
| This policy covers generative AI tools specifically. Non-generative tools like spell check, grammar correction, syntax highlighting, and basic IDE autocomplete are not in scope. |
There was a problem hiding this comment.
| This policy covers generative AI tools specifically. Non-generative tools like spell check, grammar correction, syntax highlighting, and basic IDE autocomplete are not in scope. | |
| This policy covers generative AI tools, especially (but not only) when used for contributing code, issues, PR comments, and documentation. Non-generative tools like spell check, grammar correction, syntax highlighting, and basic/deterministic IDE autocomplete are not in scope. |
There was a problem hiding this comment.
this combines the deleted part above to be more concise without repeating stuff.
CONTRIBUTING.md
Outdated
|
|
||
| ### Quality standards | ||
|
|
||
| AI-assisted contributions are held to the **same bar** as everything else. Good code is good code regardless of how it was written. Bad code gets rejected regardless of how it was written. |
There was a problem hiding this comment.
we should probbaly soften this language so we arent accusing anyone with a closed PR of having "bad code"
…ment guidelines Signed-off-by: Shlok Gilda <gildashlok@hotmail.com>
Signed-off-by: Shlok Gilda <gildashlok@hotmail.com>
|
Pushed an update addressing the new feedback:
Also added a general |
Description: Adds an AI disclosure policy to Augur, covering two files:
Notes for Reviewers: This is a draft for all maintainers to workshop. A few things worth discussing:
Assisted-by:) and AGENTS.md are intentionally left out for nowReferences used: ada-url, Zulip, LLVM, Linux Foundation.
Signed commits
AI Disclosure: Used Claude to improve grammar.