Skip to content

docs(code): add principle and pattern guidelines with skill restructuring#1871

Merged
LNSD merged 1 commit intomainfrom
lnsd/docs-code-docs-code-principles
Feb 26, 2026
Merged

docs(code): add principle and pattern guidelines with skill restructuring#1871
LNSD merged 1 commit intomainfrom
lnsd/docs-code-docs-code-principles

Conversation

@LNSD
Copy link
Contributor

@LNSD LNSD commented Feb 26, 2026

Establish comprehensive code guidelines by extracting principles and patterns into dedicated docs, replacing monolithic files with focused, discoverable documents.

  • Add 7 principle docs (SRP, OCP, Law of Demeter, Validate at Edge, Type-Driven Design, Idempotency, IoC)
  • Add 3 pattern docs (Builder, Service, Typestate), replacing rust-service.md and rust-types.md
  • Rename skills for consistency: code-pattern-discoverycode-discovery, code-pattern-fmt-checkdocs-code-fmt-check, feature-fmt-checkdocs-features-fmt-check
  • Update AGENTS.md with mandatory principles table and revised skill references
  • Add meta specs for code-pattern and code-principle doc formats

…ring

Establish comprehensive code guidelines by extracting principles and patterns into dedicated docs, replacing monolithic files with focused, discoverable documents.

- Add 7 principle docs (SRP, OCP, Law of Demeter, Validate at Edge, Type-Driven Design, Idempotency, IoC)
- Add 3 pattern docs (Builder, Service, Typestate) replacing `rust-service.md` and `rust-types.md`
- Rename skills for consistency: `code-pattern-discovery` → `code-discovery`, `code-pattern-fmt-check` → `docs-code-fmt-check`, `feature-fmt-check` → `docs-features-fmt-check`
- Update AGENTS.md with mandatory principles table and revised skill references
- Add meta specs for code-pattern and code-principle doc formats

Signed-off-by: Lorenzo Delgado <lorenzo@edgeandnode.com>
@LNSD LNSD self-assigned this Feb 26, 2026
@LNSD LNSD added documentation Improvements or additions to documentation workflow labels Feb 26, 2026
## Query Matching Guidelines

### Pattern Types
### Guideline Types
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why make this change from 'Pattern' to 'Guideline'? Does it offer any benefits?
I would have thought 'Pattern' is more explicit and unequivocal for Claude.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because it is a more generic term for what the docs/code/ section contains.

Now, it also contains "coding principles". Those are not design patterns. Those are guidelines and best practices.

@LNSD LNSD requested a review from mitchhs12 February 26, 2026 15:06
@LNSD LNSD merged commit 9555992 into main Feb 26, 2026
33 of 38 checks passed
@LNSD LNSD deleted the lnsd/docs-code-docs-code-principles branch February 26, 2026 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation workflow

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants