Skip to content

Add CONTRIBUTING.md and AGENTS.md#377

Open
nuttycom wants to merge 4 commits intomainfrom
contribution_guidelines
Open

Add CONTRIBUTING.md and AGENTS.md#377
nuttycom wants to merge 4 commits intomainfrom
contribution_guidelines

Conversation

@nuttycom
Copy link
Contributor

No description provided.

@nullcopy
Copy link
Contributor

It might be nice to mention rust-fmt as not all IDEs automatically format patches

@nuttycom nuttycom force-pushed the contribution_guidelines branch from e322f61 to d542f4b Compare February 19, 2026 00:45
Provides AI agents with project context, contribution policies, and
coding standards distilled from CONTRIBUTING.md. Includes a contribution
gate (modeled on Zebra's AGENTS.md) requiring prior issue discussion
before opening PRs, maintainer bypass via gh CLI, build/test/lint
commands, and a summary of the project's coding style requirements.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@nuttycom nuttycom changed the title Add CONTRIBUTING.md Add CONTRIBUTING.md and AGENTS.md Feb 19, 2026
Copy link
Contributor

@daira daira left a comment

Choose a reason for hiding this comment

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

ACK with significant suggestions.

Co-authored-by: Daira-Emma Hopwood <daira@jacaranda.org>
@nuttycom
Copy link
Contributor Author

Something that I just learned from @sellout is that if we put our CONTRIBUTING.md and AGENTS.md in the org-level .github repository, they should be propagated to all of the projects in that org. Should we take this approach, and simply rework these to not be project- or repository-specific?

@schell
Copy link

schell commented Feb 25, 2026

How would that look when starting up an agent? Does the AGENTS.md file get automatically cloned into the repo at checkout, or would we have to direct our agent to the file?

@sellout
Copy link
Collaborator

sellout commented Feb 25, 2026

I don’t think it supports AGENTS.md, but it does CONTRIBUTING, CODE_OF_CONDUCT, and a bunch of others. It doesn’t clone it, but the GitHub links to those sorts of things will point to the upstream version if one doesn’t exist in the downstream repo.

More here: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

@schell
Copy link

schell commented Feb 25, 2026

Thanks @sellout 🙇 . So it sounds like that solves the issue of human contributors looking at projects on GitHub, but doesn't solve our issue of human contributors starting up an agent in a cloned repository.

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.

5 participants