Add comprehensive code and test writing guides - #1
Merged
Conversation
…GUIDE.md, TEST_WRITING_GUIDE.md Mirrors the documentation structure from BitcoinAddressFinder, adapted for the Maven plugin context (Maven Log, GGUF/JNI provider, Mojo architecture). https://claude.ai/code/session_017t5CsBznigJ7pyVkadJg97
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds three authoritative reference documents to guide contributors on code style, test conventions, and project context:
TEST_WRITING_GUIDE.md— Complete reference for writing JUnit 4 tests with Hamcrest assertions, data providers, mocking patterns, and editor fold organizationCODE_WRITING_GUIDE.md— Standards for production code including named constants (DRY principle), logger injection, records for immutable types, and defensive null checksCLAUDE.md— Project overview, architecture, build commands, dependencies, and CI/CD guidance for AI assistants and contributorsCODE_OF_CONDUCT.md— Contributor Covenant 2.0 code of conductKey Changes
TEST_WRITING_GUIDE.md (572 lines)
// pre-assertsectionsjunit-dataprovidermethodUnderTest_inputOrCondition_expectedBehaviorCODE_WRITING_GUIDE.md (167 lines)
CLAUDE.md (363 lines)
CODE_OF_CONDUCT.md (128 lines)
Notable Details
https://claude.ai/code/session_017t5CsBznigJ7pyVkadJg97