Commit Graph

6 Commits

Author SHA1 Message Date
Jukka Aho cded31c388 docs: align README and CONTRIBUTING with commit-msg rules
Top-level and contributor README text now mention layout as well as width when
hooks gate commits.

- Note subject and bullet structure in README.md contributing blurb
- Mirror the same requirement in docs/CONTRIBUTING.md Git subsection
2026-05-11 02:46:20 +03:00
Jukka Aho 77766d6ee4 chore(githooks): add commit-msg hook for 80-column messages
Long commit subjects and bullets are hard to read in narrow terminals and
mailed logs. Contributors using `.githooks` via core.hooksPath now get an
automatic guard in addition to the two-file pre-commit cap.

- Add `.githooks/commit-msg` to fail when any message line exceeds 80 chars
- Skip length checks while `.git/MERGE_HEAD` exists for merge commits
- Sync AGENTS.md, README.md, CONTRIBUTING.md, and commit.prompt.md
2026-05-11 02:37:38 +03:00
Jukka Aho 58424ca93f docs(contributing): document SPDX headers per file type
Spell out that SPDX tags must use native comments (`#` in code and TOML,
HTML comments in Markdown/Quarto) and call out formats like JSON that cannot
carry in-file blocks.

- Add an SPDX section with concrete examples and the strict-JSON caveat.
2026-05-09 17:32:29 +03:00
Jukka Aho d711cab0d3 docs(contributing): note scaled commit message bodies
Explain next to the one-file workflow that message depth should follow patch
size—grouped bullets on large or multi-concern commits.

- Adds one bullet under coding rules pointing readers at `.github/prompts/commit.prompt.md`.
2026-05-09 16:44:46 +03:00
Jukka Aho 3bdbde3326 docs: Refresh README and contributing guide for post-reset API
Replace outdated badges and roadmap prose with the current 2.0 focus areas,
installation notes, and pointers to AGENTS.md. Rewrite CONTRIBUTING as a
concise fork/test/layer-contract checklist aligned with the repo layout.

- README: drop stale Travis/Gitter stack; document legacy module caveat
- CONTRIBUTING: remove Quarto front matter; link architecture_layers checker
2026-05-09 16:21:06 +03:00
Jukka Aho 241fadc669 docs: Add contributor quick-start guide
New file providing step-by-step onboarding for contributors:
- Quick links to contributor manual, coding standards, and testing philosophy
- 8-step workflow from fork to pull request
- Code of conduct principles (respectful, constructive, welcoming)
- Clear acceptance criteria (type stability, tests, documentation, clean commits)
- Rejection criteria (type instability, no tests, Greek letters, breaking changes)
- Help resources (discussions, issues, PRs)
- MIT license acknowledgment
2025-11-09 08:23:16 +02:00