|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thanks for helping keep Awesome Agentic Coding practical and current. |
| 4 | + |
| 5 | +## What Belongs Here |
| 6 | + |
| 7 | +Roadmap additions should describe a concrete engineering use case that deepens agentic coding practice. Each roadmap item needs: |
| 8 | + |
| 9 | +- A concise explanation of why the technique matters. |
| 10 | +- An **In practice** prompt that readers can apply to their own work. |
| 11 | +- A clear distinction from existing roadmap items. |
| 12 | + |
| 13 | +Toolbox additions should: |
| 14 | + |
| 15 | +- Support one or more roadmap items. |
| 16 | +- Be actively maintained and documented. |
| 17 | +- Have demonstrated adoption or a strong reason for inclusion. |
| 18 | +- Add meaningful coverage rather than duplicate an existing tool. |
| 19 | + |
| 20 | +Popularity signals such as GitHub stars may inform curation, but they are not sufficient on their own. Commercial tools without public repositories may be included when they are widely used and directly relevant. |
| 21 | + |
| 22 | +## Before Opening a Pull Request |
| 23 | + |
| 24 | +1. Search the roadmap and Toolbox for duplicates. |
| 25 | +2. Confirm every new link resolves. |
| 26 | +3. Use the existing one-line entry format: `[Name](URL) — Description.` |
| 27 | +4. Keep descriptions factual and avoid marketing language. |
| 28 | +5. Add entries to the most specific existing category. |
| 29 | +6. Run `npx awesome-lint`. |
| 30 | + |
| 31 | +For a new roadmap item, explain why the use case is not already covered. For a Toolbox entry, name the roadmap item or items it supports. |
| 32 | + |
| 33 | +## Pull Requests |
| 34 | + |
| 35 | +Keep pull requests focused. In the description, include: |
| 36 | + |
| 37 | +- What you are adding or changing. |
| 38 | +- Why it belongs in the roadmap or Toolbox. |
| 39 | +- Evidence that the resource is maintained and useful. |
| 40 | + |
| 41 | +By contributing, you agree that your contribution is licensed under the [Creative Commons Attribution 4.0 International License](LICENSE). |
| 42 | + |
| 43 | +## Reporting Problems |
| 44 | + |
| 45 | +Use the issue forms to suggest a resource or report a broken or outdated link. Security vulnerabilities should be reported privately through GitHub's security advisory feature rather than a public issue. |
0 commit comments