Skip to content

Document JSON output contract#54

Merged
Will-thom merged 1 commit into
mainfrom
issue-8-json-contract-docs
May 26, 2026
Merged

Document JSON output contract#54
Will-thom merged 1 commit into
mainfrom
issue-8-json-contract-docs

Conversation

@Will-thom
Copy link
Copy Markdown
Collaborator

Summary

  • add docs/json-contract.md with Report, Summary, Module, and Finding field documentation
  • include a complete demo JSON example with portable projectRoot placeholder
  • document JSON compatibility expectations and link the guide from README and usage docs

Validation

  • go test ./...

Closes #8

@github-actions
Copy link
Copy Markdown

Hi @Will-thom, thank you for contributing to PR Maven CLI.

I appreciate the time you spent opening this pull request. This project is intentionally shaped for focused, reviewable open source contributions, so your input helps the tool become more useful for Java and Maven teams.

A maintainer will review the context, labels, and next steps as soon as possible. If this is your first contribution here, welcome aboard.

Useful links:

  • Contributing guide: CONTRIBUTING.md
  • Testing guide: docs/testing.md
  • CI/CD guide: docs/ci.md

Thank you for helping build a deterministic, local-first Maven failure triage tool.

@Will-thom Will-thom merged commit d18844f into main May 26, 2026
21 checks passed
@Will-thom Will-thom deleted the issue-8-json-contract-docs branch May 26, 2026 23:28
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.

[Stage 2] Document the JSON contract

1 participant