Skip to content

docs: add agent contributor guide #118

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

Open
ayushcodes13 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add agent contributor guide #118

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
45 changes: 45 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Agent Contributor Guide

This repository is Codanna: a local code-intelligence MCP server and CLI for AI coding agents. Keep changes small, local-first, and easy to verify.

## Start Here

Before changing code, read:

- `README.md` for product scope, supported modes, and user-facing behavior.
- `CONTRIBUTING.md` for the short contribution workflow.
- `contributing/README.md` and `contributing/development/guidelines.md` for Rust development rules.
- `contributing/development/language-support.md` before parser or language-support work.
- `.mcp_stdio.json`, `CLAUDE.md.example`, and `.codannaignore` when touching MCP integration, agent handoff, or indexing behavior.

## Important Areas

Be extra careful with changes to:

- `src/` parser, indexing, relationship, semantic-search, and MCP code.
- MCP stdio / HTTP / HTTPS transport behavior.
- Document/RAG indexing and `.codannaignore` handling.
- Embedding model download/configuration and any remote embedding opt-in paths.
- Install scripts, release packaging, and profile/integration templates.
- Language parser grammars or generated parser analysis files under `contributing/parsers/`.

## Verification

Use the existing scripts instead of inventing new checks:

```bash
cargo build --release --all-features
./contributing/scripts/quick-check.sh
./contributing/scripts/auto-fix.sh
./contributing/scripts/full-test.sh
```

For small docs-only changes, at minimum run a diff/format sanity check and state that no code tests were needed. For code changes, prefer a targeted test first, then the relevant contributor script.

## Pull Request Notes

- Keep PRs focused on one issue or behavior.
- Add or update tests for behavior changes.
- Update docs when user-facing commands, MCP contracts, configuration, or language support changes.
- Do not commit generated or cache directories such as `.codanna/` unless maintainers explicitly ask.
- If a change affects agent integration, include the MCP/CLI command you used to verify it.