Skip to content

Commit 5953684

Browse files
authored
chore: consolidate agent instructions into .claude/CLAUDE.md (#1855)
1 parent 0b3d56c commit 5953684

9 files changed

Lines changed: 114 additions & 326 deletions

File tree

.claude/CLAUDE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* New branches cannot be made on MFlowCode/MFC, they are made on forks
2+
* PRs:
3+
* made using AI tools like Claude Code and Codex should say so.
4+
* are made from those MFC forks
5+
* that change CFD result need verification PR is correct
6+
* follow template
7+
* that break a feature but promise a followup PR to fix it are rejected
8+
* Commands:
9+
* MFC should almost always build and run using the ./mfc.sh command
10+
* Running mfc.sh commands can create a lock file in build/ that is sticky, be careful
11+
* Programming and Design:
12+
* New code should follow the DRY principle and also make side-effect code DRY as well
13+
* Comments should be as short as possible without sacrificing value
14+
* GPU macros should follow existing the source's GPU macro principles and patterns
15+
* Functions/subroutines/modules shorter is better while being correctness, fast, and separating concerns

.claude/rules/common-pitfalls.md

Lines changed: 0 additions & 173 deletions
This file was deleted.

.github/workflows/claude-code-review.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ jobs:
206206
207207
Hard scope rules:
208208
- Do NOT inspect checked-out repository code except:
209-
- ./CLAUDE.md
209+
- ./.claude/CLAUDE.md
210210
- ./.claude/rules/*.md (max 10 files)
211211
- ${{ steps.review_input.outputs.review_diff_path }}
212212
- ${{ steps.review_input.outputs.changed_files_path }}
@@ -225,7 +225,7 @@ jobs:
225225
226226
Allowed workflow:
227227
1) ls -1 .claude/rules 2>/dev/null || true
228-
2) cat CLAUDE.md 2>/dev/null || true
228+
2) cat .claude/CLAUDE.md 2>/dev/null || true
229229
3) find .claude/rules -maxdepth 1 -name "*.md" -print | head -n 10 | xargs -I{} cat "{}" 2>/dev/null || true
230230
4) cat "${{ steps.review_input.outputs.changed_files_path }}"
231231
5) cat "${{ steps.review_input.outputs.review_diff_path }}"
@@ -238,7 +238,7 @@ jobs:
238238
- Do NOT restate the full PR summary.
239239
- If there are no high-confidence findings, leave .claude-review/output.md empty and STOP.
240240
241-
Review standard (in priority order per CLAUDE.md "Code Review Priorities"):
241+
Review standard (in priority order):
242242
1. Correctness (logic bugs, numerical issues, array bounds)
243243
2. Precision discipline (stp vs wp mixing)
244244
3. Memory management (@:ALLOCATE/@:DEALLOCATE pairing, GPU pointer setup)

AGENTS.md

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

0 commit comments

Comments
 (0)