Commit Graph
8 Commits
Author SHA1 Message Date
AlexisLeDain 676f3f3daf docs: exempt deliberate boundaries from the second-caller rule
As written, the bullet banned any interface with a single implementation,
which contradicts the Repository Pattern in rules/common/patterns.md: it
requires business logic to depend on an abstract repository interface,
and a project backed by one database has exactly one implementation.

Scope the rule to speculative abstractions and name the exemption, so the
two files in rules/common/ no longer give opposite instructions.
2026-11-04 09:42:54 +01:00
AlexisLeDainandClaude Opus 5 1cf547bfd7 docs: make YAGNI and root-cause rules concrete
The YAGNI section states the principle three times in the abstract
("avoid speculative generality", "introduce abstractions when repetition
is real") without naming a threshold an agent can test against. The same
gap exists in the review checklist for bug fixes: nothing tells a
reviewer to look past the reported symptom.

Add one bullet to each, both phrased as a check rather than an
aspiration: the second caller as the bar for introducing an abstraction,
and the sibling callers as the bar for accepting a bug fix.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-11-03 17:10:00 +01:00
haelyra 013ed0a8e6 fix(rules): make Boolean naming guidance neutral 2026-09-10 15:01:03 -04:00
haelyra a0ecb7939a fix(rules): keep common naming guidance language-neutral 2026-09-10 15:01:03 -04:00
Ralf Penka 072e468430 fix(rules): stop prescribing JS casing for every language in common/
`common/coding-style.md` has no `paths:` frontmatter, so it is loaded for every
source file regardless of language. Its Naming Conventions section nevertheless
prescribed `camelCase` for variables and functions, which is not idiomatic for
several languages the package supports: `python/coding-style.md` mandates PEP 8
(`snake_case`) and `rust/coding-style.md` mandates `snake_case` for functions,
methods and variables. Both carry `paths:` frontmatter, so for a .py or .rs file
the agent is handed two opposite naming rules in the same context. README.md does
state that language-specific rules take precedence, but that statement lives in
the README rather than in the rule files the agent actually receives.

Replace the casing list with the canonical `**Language note**` marker documented
in rules/README.md, and keep only what is genuinely language-independent:
descriptive names, boolean prefixes, and constants and types being visually
distinct from values, and only where the language draws that distinction at all.
The per-language examples name only languages whose own coding-style.md actually
states a casing standard.

Drop the "Custom hooks: camelCase with a use prefix" line and link to
react/coding-style.md instead — it is React-specific and documented there both as
the `useCamelCase` symbol rule and as the eslint-plugin-react-hooks enforcement
note. react/coding-style.md is path-scoped, so a hook colocated outside
`components/**` or `hooks/**` no longer receives the rule; see the PR description.

Fixes #2830
2026-09-10 15:01:03 -04:00
Suliman Abdulrazzaq 60e27fe51e docs(rules): clarify 800-line review ceiling 2026-08-24 22:26:33 -03:00
Affaan Mustafa adebf3e30b docs: fold stocktake rule guidance into common rules 2026-04-05 15:49:43 -07:00
86b5a53e5d refactor(rules): restructure into common + language-specific directories
* refactor(rules): restructure rules into common + language-specific directories

- Split 8 flat rule files into common/, typescript/, python/, golang/
- common/ contains language-agnostic principles (no code examples)
- typescript/ extracts TS/JS specifics (Zod, Playwright, Prettier hooks, etc.)
- python/ adds Python rules (PEP 8, pytest, black/ruff, bandit)
- golang/ adds Go rules (gofmt, table-driven tests, gosec, functional options)
- Replace deprecated ultrathink with extended thinking documentation
- Add README.md with installation guide and new-language template

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Fix installation commands for rules

Updated installation instructions to copy all rules to a single directory.

* docs: update README.md to reflect new rules directory structure

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

---------

Co-authored-by: Hor1zonZzz <Hor1zonZzz@users.noreply.github.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-05 05:58:06 -08:00