Skip to content

Docs-first sweep — tighten contributor rules, enrich tech docs & clarify build scripts #1184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: adv/docs
Choose a base branch
from

Conversation

peter-lawrey
Copy link
Member

@peter-lawrey peter-lawrey commented Jun 2, 2025

Area File(s) Highlights
Contributor guidance AGENTS.md Added Oxford link, ASCII-7 lint tip, inline-comment example, when-to-open-PR section, mvn clean verify emphasis.
Wire docs EventsByMethod.adoc, YAML2SpecificationCompliance.adoc Expanded rationale, added sequence diagram, “Core components”, concrete YAML snippet, compliance overview & deviations/extensions.
House-style polish AGENTS.md, .adoc docs Switched smart quotes → ASCII, wrapped long lines, US→UK spelling fixes.
Build clarity root pom.xml, module POMs Comment blocks explaining BOM usage, plugins’ purpose, Sonar & benchmark profiles.
System properties system.properties (root + demos/perf) Documented every flag with default & behaviour.
Demo & perf code numerous src/main/java/... Added class-level Javadoc, main method docs, clarified DTO field purpose, etc. (no logic change).
Resource clean-up common-words.txt, more-common-words.txt Header comments, one-word-per-line rule; WordsLongConverter now skips blank/comment lines (backwards compatible).
Internal pkg info internal/package-info.java Rewritten to concise “not public API” notice.
Docs helper EventsByMethod.adoc → added Mermaid sequence diagram.

No production code or public API behaviour altered apart from comment-line skip in WordsLongConverter (transparent).

@peter-lawrey peter-lawrey changed the title Adv/33 conf Docs-first sweep — tighten contributor rules, enrich tech docs & clarify build scripts Jun 2, 2025
@peter-lawrey peter-lawrey requested a review from tgd June 3, 2025 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant