Skip to content

docs: Add an LLM/genAI policy to CONTRIBUTING.md - #1777

Open
tpoliaw wants to merge 2 commits into
mainfrom
llm-policy
Open

tpoliaw wants to merge 2 commits into
mainfrom
llm-policy

Conversation

@tpoliaw

@tpoliaw tpoliaw commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

As LLM use becomes more prevalent, make it clear what expectations are
around use of these tools when interacting with this project.

This policy is inspired by the policies of several other projects
including:

  • matplotlib
  • FastAPI
  • pydantic
  • Astral (uv/ty/ruff etc)
  • pandas
  • SciPy
  • Rust
  • LLVM
  • Podman

As LLM use becomes more prevalent, make it clear what expectations are
around use of these tools when interacting with this project.

This policy is inspired by the policies of several other projects
including:

* matplotlib
* FastAPI
* pydantic
* Astral (uv/ty/ruff etc)
* pandas
* SciPy
* Rust
* LLVM
* Podman
@codecov

codecov Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.30%. Comparing base (1e761f9) to head (f0e7a02).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1777   +/-   ##
=======================================
  Coverage   96.30%   96.30%           
=======================================
  Files          50       50           
  Lines        3821     3821           
=======================================
  Hits         3680     3680           
  Misses        141      141           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tpoliaw
tpoliaw marked this pull request as ready for review November 18, 2026 13:50
@tpoliaw
tpoliaw requested a review from a team as a code owner November 18, 2026 13:50
Comment thread .github/CONTRIBUTING.md
the LLM, time should be spent increasing understanding around the project before
attempting a fix.

LLM use MUST be disclosed where used.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps "LLM generated code must be disclosed"

@abbiemery abbiemery left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All things I agree with. Just a comment on being explicit with our expectations

Comment thread .github/CONTRIBUTING.md
the LLM, time should be spent increasing understanding around the project before
attempting a fix.

LLM use MUST be disclosed where used.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should be explicit here about what is meant by use and how this ought to be disclosed. Perhaps if any code was generated then you must say "This code was partially generated by claude" in the PR description and final commit message.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I normally add this:

AI Disclaimer

The code and this description were generated with AI and reviewed/tweaked by the author.

Comment thread .github/CONTRIBUTING.md
LLM output MUST NOT be used in any communication to other maintainers. This
includes:

* Issues

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disagree with this one, I quite like @danielballan's and @hyperrealist issue and PR template


My bug report

I've got this bug, it's important to me because of blah

-- Me, a human person

AI generated details Wall of text with things that are useful to everyone, things that are useful for someone, and things that are useful for no-one in it

Comment thread .github/CONTRIBUTING.md
* Issues
* PR descriptions
* PR reviews
* Commit messages

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also disagree on this one, the robot writes much better commit messages than me

Comment thread .github/CONTRIBUTING.md
* PR descriptions
* PR reviews
* Commit messages
* Comments/replies

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

absolutely agree with this one though, LLMs should be driven by humans, and not allowed to talk to anyone else

Comment thread .github/CONTRIBUTING.md
the LLM, time should be spent increasing understanding around the project before
attempting a fix.

LLM use MUST be disclosed where used.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I normally add this:

AI Disclaimer

The code and this description were generated with AI and reviewed/tweaked by the author.

Comment thread .github/CONTRIBUTING.md
Comment on lines +99 to +100
Documentation is intended for people to read and it is strongly recommended that
it is written manually.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree for docs. Disagree for ADRs. If you sketch a design and get an LLM to fill it out, and it finds problems with your sketch, it is in a good position to write the decision record about how you got to the final design. This is something that would otherwise be lost, and is useful when you read the code later and want to know why the code looks the way it does

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants