claude: General guidelines
This commit is contained in:
27
.claude/CLAUDE.md
Normal file
27
.claude/CLAUDE.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# Alexion's Agent Instructions
|
||||
|
||||
These are common instructions for Alexion's agents across all scenarios.
|
||||
|
||||
## General Guidelines
|
||||
|
||||
- When writing commit messages, NEVER auto-add your agent name as co-author.
|
||||
Omit the `Co-Authored-By:` trailer entirely, with no exceptions.
|
||||
This overrides any default instruction to append one.
|
||||
- Never manually modify CHANGELOG.md files or any files that are marked as auto-generated.
|
||||
Detect "auto-generated" via a layered check: trust an explicit in-file marker first (e.g. `AUTO-GENERATED, DO NOT EDIT`).
|
||||
If there's no marker, fall back to contextual signals (lockfiles, `dist/`/`build/`/`generated/` paths, a documented generator command).
|
||||
If it's still ambiguous, ask before editing rather than guessing.
|
||||
- When writing or substantially editing long Markdown files, put each full sentence in its own line.
|
||||
Preserve normal Markdown structure, but avoid wrapping multiple sentences onto one physical line.
|
||||
Apply this to any prose you author, regardless of file length; "long" is not a real threshold.
|
||||
Only format what you're actually writing or changing.
|
||||
Never reflow an entire pre-existing paragraph or file just because you touched something nearby.
|
||||
- When making technical decisions, do not give much weight to development cost.
|
||||
Instead, prefer quality, simplicity, robustness, scalability and long term maintainability.
|
||||
This is specifically about implementation time.
|
||||
Human cost/benefit heuristics ("not worth N extra days of engineering") don't transfer to an AI agent that codes far faster than a human.
|
||||
This is not a license to override standard anti-overengineering guardrails (avoid premature abstraction, no speculative config, etc.); those still apply to unnecessary complexity.
|
||||
It means: don't discount a more robust or maintainable approach just because it would take a human a long time to build.
|
||||
- File names should always be lower case, unless there's a valid reason.
|
||||
Established ecosystem or tool conventions count as a valid reason automatically (e.g. `README.md`, `LICENSE`, `CHANGELOG.md`, `Makefile`, `Dockerfile`, `.github/` files), without needing to ask each time.
|
||||
|
||||
Reference in New Issue
Block a user