Skip to content

docs: add guidance for contributors using AI coding agents #4219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
adityatiwari101104 wants to merge 1 commit into from
Closed

docs: add guidance for contributors using AI coding agents #4219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,17 @@ Use a conventional-commit prefix (e.g., `fix:`, `feat:`, `docs:`, `fix(extract):
- Keep description synchronized with final implementation.
- Rebase/resolve conflicts before requesting final review.

## Working with AI Coding Agents
AI assistants are welcome, but every rule in this guide applies to the code they write, and you remain the author of the PR.
- Point your agent at this file and [ARCHITECTURE.md](ARCHITECTURE.md) before it changes anything.
- Branch off `upstream/v8`, keep the PR to one concern, and never let an agent hand-edit generated skill files.
- For bug fixes, confirm the regression test fails without the fix, not only that it passes with it.
- Run the checks yourself before opening the PR: `uv run pytest tests`, `uv run ruff check .`, `uv run pyright`.
- Disclose material AI help with a `Co-Authored-By:` trailer, as described under [Commit Messages](#commit-messages).
- Write the PR description yourself, and list the commands you actually ran.

Optional: [ContribOS](https://github.com/adityatiwari101104/contribos) can list these rules with file and line references (`contribos policy Graphify-Labs/graphify`) and review a branch against them before you open a PR (`contribos check`).

## Issue Reports
### Bugs
Include exact version/commit, environment, minimal reproduction, expected vs actual, logs, graph/cache artifacts where relevant, and whether a clean checkout reproduced it.
Expand Down