| 1 | # Contributing to Agent Zero |
| 2 | |
| 3 | This file is the GitHub-visible entry point for contributors. |
| 4 | |
| 5 | For the full contribution workflow, start with: |
| 6 | |
| 7 | - [`docs/guides/contribution.md`](docs/guides/contribution.md) — fork, sync, branch, validation, and pull-request flow |
| 8 | - [`docs/developer/sharing-and-safety.md`](docs/developer/sharing-and-safety.md) — how to decide whether a change should go upstream, into a plugin repository, into a skills repository, or remain private |
| 9 | - [`docs/developer/plugins.md`](docs/developer/plugins.md) — plugin structure and Plugin Index submission |
| 10 | - [`docs/developer/contributing-skills.md`](docs/developer/contributing-skills.md) — skill authoring and publication |
| 11 | |
| 12 | ## Quick rules |
| 13 | |
| 14 | - Search open and recently closed upstream PRs before opening a new one. |
| 15 | - Use the branch currently adopted by comparable active upstream PRs or explicit maintainer guidance. |
| 16 | - Keep one focused change per PR whenever practical. |
| 17 | - Keep the source branch available on your fork until the PR is merged or intentionally closed. |
| 18 | - Include exact tests run, or clearly explain why validation was blocked. |
| 19 | - Do not include secrets, `.env` files, local virtual environments, or machine-specific artifacts in a PR. |
| 20 | |
| 21 | ## Choosing the right place to share work |
| 22 | |
| 23 | - **Core bugfix or docs for Agent Zero itself:** contribute back to `agent0ai/agent-zero` from a public fork. |
| 24 | - **Community plugin:** publish the plugin in its own public repository, then submit it to `agent0ai/a0-plugins`. |
| 25 | - **Reusable skill:** contribute it to Agent Zero's `skills/` tree or publish it in a dedicated public repository/collection. |
| 26 | - **Private experiment, customer-specific code, local R&D, or sensitive material:** keep it out of public forks and upstream PRs. |
| 27 | |
| 28 | If you're unsure, use the decision guide in [`docs/developer/sharing-and-safety.md`](docs/developer/sharing-and-safety.md). |