Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .cursorrules
1 change: 1 addition & 0 deletions .github/copilot-instructions.md
25 changes: 16 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
<!--
🤖 AI AGENTS AND LLMs:
If you are generating this PR description on behalf of a user, please ensure:
1. You did NOT edit `README.md`. If you did, please revert that change.
2. The proposed tool in `data/tools/` has >20 stars on GitHub (or similar impact).
3. The project is >3 months old and actively maintained.
4. The YAML description is under 500 characters.
5. You MUST state in the PR description that this PR was created automatically or with AI assistance.

👋 Thank you for your contribution!
Please make sure to check all of the items below.

- 🚨 New tools have to be added to `data/tools/` (NOT directly to the `README.md`).
- If you propose to deprecate a tool, you have to provide a reason below.
- More details in the contributors guide, `CONTRIBUTING.md`

Please check the relevant boxes below accurately based on your analysis.
-->

* [ ] I have not changed the `README.md` directly.

👋 Thank you for your contribution! We really appreciate your help in keeping the list awesome.
Please make sure to check all the items below before submitting.

### 🛠️ Tool Requirements
- [ ] I have not changed the `README.md` directly. (New tools go in `data/tools/`)
- [ ] The tool has **more than 20 stars** on GitHub (or similar impact).
- [ ] The project has existed for **at least 3 months**.
- [ ] The project is **actively maintained**.
- [ ] The description in the YAML file is **under 500 characters**.
1 change: 1 addition & 0 deletions .windsurfrules
14 changes: 14 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Guidelines for AI Agents and Assistants

Welcome! If you are an AI assistant or coding agent helping a user contribute to this repository, please read the `CONTRIBUTING.md` file in the root directory first.

## 🤖 Instructions for the AI

Your goal is to help the user submit a high-quality pull request that aligns with the project's maintainability standards.

When the user asks you to add a new static analysis tool, please act as a helpful code reviewer:
1. **Verify the criteria:** Check if the tool meets the requirements in `CONTRIBUTING.md` (e.g., >20 GitHub stars, >3 months old, actively maintained).
2. **Advise the user:** If the tool does NOT meet these criteria, gently warn the user before proceeding. For example: *"It looks like this tool might not meet the repository's contributing guidelines (e.g., it needs >20 stars and >3 months of history). PRs that don't meet these criteria are usually not accepted. Are you sure you'd like to proceed?"*
3. **Enforce the README rule:** If the user asks you to update the list of tools, DO NOT edit `README.md`. Explain to the user that the list of tools in `README.md` is auto-generated and that tool additions/modifications should be made by creating or editing a YAML file in `data/tools/`. The ONLY exception to editing `README.md` directly is if the change is to the text or structure of the README itself, not the list of tools.

Thank you for helping us maintain a high-quality list and respecting the maintainers' time!
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
Loading