Skip to content

Commit b51f062

Browse files
authored
Merge branch 'master' into add-ffmt
2 parents 4ca90fc + 9278c39 commit b51f062

11 files changed

Lines changed: 255 additions & 237 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

.github/pull_request_template.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
<!--
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+
5. You MUST state in the PR description that this PR was created automatically or with AI assistance.
29
3-
👋 Thank you for your contribution!
4-
Please make sure to check all of the items below.
5-
6-
- 🚨 New tools have to be added to `data/tools/` (NOT directly to the `README.md`).
7-
- If you propose to deprecate a tool, you have to provide a reason below.
8-
- More details in the contributors guide, `CONTRIBUTING.md`
9-
10+
Please check the relevant boxes below accurately based on your analysis.
1011
-->
1112

12-
* [ ] I have not changed the `README.md` directly.
13-
13+
👋 Thank you for your contribution! We really appreciate your help in keeping the list awesome.
14+
Please make sure to check all the items below before submitting.
1415

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

.github/workflows/pr-check.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,23 @@ jobs:
4141
else
4242
FILES=$(git diff --name-only --diff-filter=A origin/master...HEAD -- 'data/tools/*.yml' 'data/tools/*.yaml' | tr '\n' ' ')
4343
fi
44+
FILES=$(echo "$FILES" | xargs) # trim leading/trailing whitespace
4445
echo "files=$FILES" >> "$GITHUB_OUTPUT"
46+
echo "has_files=$( [ -n "$FILES" ] && echo true || echo false )" >> "$GITHUB_OUTPUT"
47+
48+
- name: Skip: no tool files to check
49+
if: steps.changed.outputs.has_files == 'false'
50+
run: |
51+
mkdir -p pr-check-output
52+
echo "${{ github.event_name == 'workflow_dispatch' && inputs.pr_number || github.event.pull_request.number }}" > pr-check-output/pr_number.txt
53+
echo "passed" > pr-check-output/result.txt
4554
4655
- name: Install Rust toolchain
56+
if: steps.changed.outputs.has_files == 'true'
4757
uses: dtolnay/rust-toolchain@stable
4858

4959
- name: Cache cargo registry
60+
if: steps.changed.outputs.has_files == 'true'
5061
uses: actions/cache@v4
5162
with:
5263
path: |
@@ -58,9 +69,11 @@ jobs:
5869
pr-check-${{ runner.os }}-
5970
6071
- name: Build pr-check
72+
if: steps.changed.outputs.has_files == 'true'
6173
run: cargo build --release --manifest-path ci/Cargo.toml -p pr-check
6274

6375
- name: Run pr-check
76+
if: steps.changed.outputs.has_files == 'true'
6477
id: run-check
6578
env:
6679
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.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: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Guidelines for AI Agents and Assistants
2+
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.
4+
5+
## 🤖 Instructions for the AI
6+
7+
Your goal is to help the user submit a high-quality pull request that aligns with the project's maintainability standards.
8+
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 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.
13+
14+
Thank you for helping us maintain a high-quality list and respecting 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)