Skip to content

add LLM use policy and contributing guide - #442

Merged
grgmiller merged 2 commits into
complete_hourlyfrom
claude
Aug 12, 2026
Merged

grgmiller merged 2 commits into
complete_hourlyfrom
claude

Conversation

@grgmiller

@grgmiller grgmiller commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Purpose

Adds a markdown file that provides instructions to LLM models on how to assist with code changes in this repo.

The main question for reviewers is: should we include this in a public repo? There is nothing private/sensitive in the file (it is all derived from the codebase itself), but we just haven't established a policy for this yet.

Also updates the README with a LLM use policy and the PR template

@grgmiller
grgmiller marked this pull request as ready for review August 7, 2026 19:00

@brandonwang15 brandonwang15 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

lgtm

Separately though, I wonder if, since this is public, should we eventually include a note in our README about our own norms/principles around writing and reviewing AI-generated/assisted code?

We probably require more internal discussion / thought to figure out what that is ourselves, and how we want to present that, but it might be a good thing to have clarity on for something public-facing.

Also PRs are public on this repo too, just FYI, so fwiw this is technically visible already

@grgmiller

Copy link
Copy Markdown
Collaborator Author

@brandonwang15 do you think that we want to add any AI principles to this repo, like: https://github.com/catalyst-cooperative/pudl?tab=contributing-ov-file#llm-use-policy?

I think as written, this file also provides relevant design standards for contributing to this repo whether you are an LLM or a human. Would it make sense to rename this to a "CONTRIBUTING.md" file so that it is less tied to Claude specifically (but if using an LLM, you could point it to this file to understand how to contribute)?

@brandonwang15

Copy link
Copy Markdown

@brandonwang15 do you think that we want to add any AI principles to this repo, like: https://github.com/catalyst-cooperative/pudl?tab=contributing-ov-file#llm-use-policy?

I think as written, this file also provides relevant design standards for contributing to this repo whether you are an LLM or a human. Would it make sense to rename this to a "CONTRIBUTING.md" file so that it is less tied to Claude specifically (but if using an LLM, you could point it to this file to understand how to contribute)?

I'd be pro adding something like that, I like the PUDL writeup. And yeah renaming CONTRIBUTING.md makes sense to me.

@grgmiller grgmiller changed the title add CLAUDE.md add LLM use policy and contributing guide Aug 12, 2026
@grgmiller

Copy link
Copy Markdown
Collaborator Author

@brandonwang15 @sarahchute I made some updates based on your feedback, adding an LLM policy (copied from PUDL), and a section to the PR template to describe LLM use. I also renamed the file CONTRIBUTING.md instead of CLAUDE.md

@grgmiller
grgmiller merged commit 4c8c704 into main Aug 12, 2026
2 checks passed
@grgmiller
grgmiller deleted the claude branch August 12, 2026 19:13
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.

3 participants