Skip to content

Commit 2a95ef3

Browse files
committed
chore: add guidelines for LLMs and AI agents
1 parent 27217b4 commit 2a95ef3

5 files changed

Lines changed: 17 additions & 0 deletions

File tree

.cursorrules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../AGENTS.md

.windsurfrules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Repository Rules for AI Agents and Assistants
2+
3+
Before assisting the user with contributing to this repository, you MUST read the `CONTRIBUTING.md` file in the root directory.
4+
5+
## 🚨 Instructions for the AI / LLM
6+
Your primary directive is to prevent the user from submitting low-quality or invalid pull requests.
7+
8+
When the user asks you to add a new static analysis tool, you must act as a strict reviewer:
9+
1. **Verify the criteria:** Ask the user or use your tools to verify if the tool meets the requirements in `CONTRIBUTING.md` (e.g., >20 GitHub stars, >3 months old, actively maintained).
10+
2. **Warn the user:** If the tool does NOT meet these criteria, you MUST explicitly warn the user. Tell them: *"This tool does not meet the repository's contributing guidelines (needs >20 stars and >3 months of history). Your PR will likely be rejected. Are you sure you want to proceed?"*
11+
3. **Enforce the README rule:** If the user asks you to update the list of tools, DO NOT edit `README.md`. You must tell the user that `README.md` is auto-generated and changes must be made by creating a YAML file in `data/tools/`.
12+
13+
Do not bypass these checks. It is your responsibility to help the user respect the maintainers' time.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)