Skip to content

Add contribution guidelines and issue/PR templates#8975

Open
alexreinking wants to merge 2 commits intomainfrom
alexreinking/contributor-guidelines
Open

Add contribution guidelines and issue/PR templates#8975
alexreinking wants to merge 2 commits intomainfrom
alexreinking/contributor-guidelines

Conversation

@alexreinking
Copy link
Member

Summary

  • Add CONTRIBUTING.md covering the issue-first workflow, testing expectations, CI requirements, AI attribution policy, and review/merge process.
  • Add GitHub issue form templates for bug reports, missed optimizations, and feature specifications.
  • Add issue template config that redirects Q&A and brainstorming to Discussions.
  • Add a PR template with a performance impact section and checklist for tests and AI attribution.

Test plan

These can only be verified after merging, since GitHub renders issue/PR templates from the default branch:

  • Verify issue templates render correctly: go to Issues > New Issue and check all three templates plus the Discussion links.
  • Verify PR template renders correctly: open a draft PR and check the pre-filled body.
  • Verify CONTRIBUTING.md renders correctly on GitHub and links resolve.
  • Review wording with other maintainers.

This is the result of a back-and-forth drafting process with Claude Code.

Add CONTRIBUTING.md covering the issue-first workflow, testing
expectations, CI requirements, and AI attribution policy.

Add GitHub issue templates for bug reports, missed optimizations,
and feature specifications, with a config that redirects Q&A and
brainstorming to Discussions.

Add a pull request template with a performance impact section and
checklist for tests and AI attribution.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@alexreinking alexreinking added the skip_buildbots Do not run buildbots on this PR. Must add before opening PR as we scan labels immediately. label Mar 2, 2026
@alexreinking alexreinking requested a review from shoaibkamil March 2, 2026 21:17
@alexreinking alexreinking added the dev_meeting Topic to be discussed at the next dev meeting label Mar 2, 2026
@mcourteaux
Copy link
Contributor

I think we should maintain a list of the exact co authored by tags for each LLM (and in particular which email address to use.)

Copy link
Contributor

@mcourteaux mcourteaux left a comment

Choose a reason for hiding this comment

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

The referenced code of conduct does not mention LLM attribution?

@alexreinking
Copy link
Member Author

The referenced code of conduct does not mention LLM attribution?

It does, though? Under "Give credit where it's due."

Additionally, any code generated by an AI tool (such as a large language model) must be clearly identified as such in the commit message using "Co-authored-by: The name of the tool". We all like recognition for our work.

@mcourteaux
Copy link
Contributor

Oops. My bad. Will approve if there is a list of LLM tags.

@alexreinking
Copy link
Member Author

alexreinking commented Mar 3, 2026

Oops. My bad. Will approve if there is a list of LLM tags.

There is no real consensus on how coding agent tools include attribution or not. Here's the conventions I've found so far, from most structured to least:

  • Claude uses Co-authored-by: Claude $MODEL <noreply@anthropic.com>
  • Cursor uses Co-authored-by: Cursor <cursoragent@cursor.com>
  • GitHub Copilot authors commits as a bot account. When it isn't the primary committer, we could insist on Co-authored-by: GitHub Copilot <$GITHUB_USER_ID+Copilot@github.com>
  • Codex (OpenAI) has no standard process. If you ask it, it tells you to use Generated-by or Assisted-by, neither of which are standard in Git's tooling. Another time I asked it, it suggested to use Co-authored-by: Codex <noreply@openai.com>. Using Co-authored-by: chatgpt-codex-connector[bot] <199175422+chatgpt-codex-connector[bot]@users.noreply.github.com> is plausible, too, see the discussion on openai/codex.
  • Gemini CLI - Also nothing standard. Discussion on google-gemini/gemini-cli suggests Co-Authored-By: Gemini 3 <gemini-code-assist@google.com> works.

All of these can be disabled or modified in their respective application settings. We'll need to discuss what to ask of contributors and how we as maintainers need to enforce at merge time.

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

Labels

dev_meeting Topic to be discussed at the next dev meeting skip_buildbots Do not run buildbots on this PR. Must add before opening PR as we scan labels immediately.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants