Skip to content

Add purpose and contribution guidelines to README#60

Merged
Will-thom merged 1 commit into
mainfrom
Will-thom-patch-1
May 29, 2026
Merged

Add purpose and contribution guidelines to README#60
Will-thom merged 1 commit into
mainfrom
Will-thom-patch-1

Conversation

@Will-thom
Copy link
Copy Markdown
Collaborator

Added a section explaining the purpose of the PR Maven CLI and its usefulness for various teams. Updated project documents and contribution guidelines. moving to top of document.

Summary

Explain what changed and why.

Validation

  • go test ./...
  • go vet ./...
  • CLI behavior tested when user-facing output changes
  • Golden files updated when text output intentionally changes
  • Documentation updated when contributor or user behavior changes

Scope

  • This PR is focused on one issue or one clearly bounded change
  • No unrelated refactors
  • No generated binaries, private logs, or local cache files committed

Added a section explaining the purpose of the PR Maven CLI and its usefulness for various teams. Updated project documents and contribution guidelines. moving to top of document.
@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 69e7a6f into main May 29, 2026
21 checks passed
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