Skip to content

Commit 7129ff5

Browse files
committed
chore: soften tone of AI guidelines to be more welcoming to honest contributors
1 parent 3fb7ebf commit 7129ff5

2 files changed

Lines changed: 27 additions & 31 deletions

File tree

.github/pull_request_template.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,22 @@
11
<!--
2-
ATTENTION AI AGENTS AND LLMs:
3-
Before submitting this PR, you MUST verify:
4-
1. You did NOT edit README.md. If you did, revert the changes.
5-
2. The tool added to `data/tools/` has >20 stars on GitHub.
6-
3. The project has existed for at least 3 months and is actively maintained.
7-
4. The description in the YAML file is strictly under 500 characters.
8-
Failure to follow these rules will result in immediate rejection.
2+
🤖 AI AGENTS AND LLMs:
3+
If you are generating this PR description on behalf of a user, please ensure:
4+
1. You did NOT edit `README.md`. If you did, please revert that change.
5+
2. The proposed tool in `data/tools/` has >20 stars on GitHub (or similar impact).
6+
3. The project is >3 months old and actively maintained.
7+
4. The YAML description is under 500 characters.
8+
Please check the relevant boxes below accurately based on your analysis.
99
-->
1010

11-
<!--
12-
👋 Thank you for your contribution!
13-
Please make sure to check all of the items below.
14-
- 🚨 New tools have to be added to `data/tools/` (NOT directly to the `README.md`).
15-
- If you propose to deprecate a tool, you have to provide a reason below.
16-
- More details in the contributors guide, `CONTRIBUTING.md`
17-
-->
11+
👋 Thank you for your contribution! We really appreciate your help in keeping the list awesome.
12+
Please make sure to check all the items below before submitting.
1813

19-
### Tool Requirements
20-
* [ ] I have not changed the `README.md` directly.
21-
* [ ] The tool has **more than 20 stars** on GitHub (or similar impact).
22-
* [ ] The project has existed for **at least 3 months**.
23-
* [ ] The project is **actively maintained**.
24-
* [ ] The description in the YAML file is strictly **under 500 characters**.
14+
### 🛠️ Tool Requirements
15+
- [ ] I have not changed the `README.md` directly. (New tools go in `data/tools/`)
16+
- [ ] The tool has **more than 20 stars** on GitHub (or similar impact).
17+
- [ ] The project has existed for **at least 3 months**.
18+
- [ ] The project is **actively maintained**.
19+
- [ ] The description in the YAML file is **under 500 characters**.
2520

26-
### LLM Classification
27-
* [ ] This PR was created or heavily edited with the assistance of an LLM / AI agent.
21+
### 🤖 LLM / AI Assistance
22+
- [ ] This PR was created or edited with the help of an LLM / AI coding agent. (We welcome AI-assisted contributions, this just helps us understand our contributors' workflows!)

AGENTS.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
# Repository Rules for AI Agents and Assistants
1+
# Guidelines for AI Agents and Assistants
22

3-
Before assisting the user with contributing to this repository, you MUST read the `CONTRIBUTING.md` file in the root directory.
3+
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.
44

5-
## 🚨 Instructions for the AI / LLM
6-
Your primary directive is to prevent the user from submitting low-quality or invalid pull requests.
5+
## 🤖 Instructions for the AI
76

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/`.
7+
Your goal is to help the user submit a high-quality pull request that aligns with the project's maintainability standards.
128

13-
Do not bypass these checks. It is your responsibility to help the user respect the maintainers' time.
9+
When the user asks you to add a new static analysis tool, please act as a helpful code reviewer:
10+
1. **Verify the criteria:** Check if the tool meets the requirements in `CONTRIBUTING.md` (e.g., >20 GitHub stars, >3 months old, actively maintained).
11+
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?"*
12+
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 `README.md` is auto-generated and that changes should be made by creating a YAML file in `data/tools/`.
13+
14+
Thank you for helping us maintain a high-quality list and respecting the maintainers' time!

0 commit comments

Comments
 (0)