Skip to content

docs: expand README usage guides, update CHANGELOG, and refine CONTRIBUTING guidelines - #8

Open
YashDoesCode wants to merge 1 commit into
mainfrom
docs/community-and-usage-guides
Open

YashDoesCode wants to merge 1 commit into
mainfrom
docs/community-and-usage-guides

Conversation

@YashDoesCode

Copy link
Copy Markdown
Owner

Summary

Significantly expands and modernizes repository documentation to provide comprehensive guidance for library users and open-source contributors.

Key Changes

  1. README.md Overhaul:
    • Added comprehensive usage guides covering basic string snapshot tests, JSON serialization via Jackson, and JDK standard XML serialization.
    • Documented advanced JUnit 5 features: mint.named(String) multi-checkpoint testing, @ParameterizedTest invocation isolation, @RepeatedTest support, and @Nested test class inheritance.
    • Added custom serializer implementation guide and snapshot directory customization.
    • Detailed snapshot updating workflow (-Dmint.update=true) and highlighted CI read-only invariants.
  2. CHANGELOG.md:
    • Formatted to Keep a Changelog standards.
    • Documented all forthcoming security, determinism, test isolation, and build improvements in [Unreleased].
  3. CONTRIBUTING.md:
    • Outlined prerequisites, local build/verify steps, and targeted test execution.
    • Codified Conventional Commits rules, scopes, and clean-code architectural invariants (Java 17, zero runtime dependencies in mint-core, immutable value objects, java.nio.file and UTF-8 enforcement).

Verification

  • Markdown formatting verified.
  • gitleaks: 0 leaks found.

@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 25 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c9bfc780-364b-49ec-9ba2-4735eadd93ba
Commits

Reviewing files that changed from the base of the PR and between b31a051 and 3839548.

Files selected for processing: 3

  • CHANGELOG.md
  • CONTRIBUTING.md
  • README.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@YashDoesCode
YashDoesCode marked this pull request as ready for review November 17, 2026 11:07
Copilot AI balanced review requested due to automatic review settings November 17, 2026 11:07

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

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.

2 participants