Skip to content

docs: add CONTRIBUTING.md and PR template#41

Open
omghante wants to merge 1 commit into
PhonePe:mainfrom
omghante:docs/39-add-contributing-md-and-pr-template
Open

docs: add CONTRIBUTING.md and PR template#41
omghante wants to merge 1 commit into
PhonePe:mainfrom
omghante:docs/39-add-contributing-md-and-pr-template

Conversation

@omghante

Copy link
Copy Markdown

Description

Add a dedicated CONTRIBUTING.md guide and a pull request template to help new contributors get started quickly.

Related Issue

Fixes #39

Changes Made

  • Added CONTRIBUTING.md at the repo root covering:
    • Development setup (fork, clone, pre-commit install)
    • Step-by-step PR workflow (branch, code, format, test, commit, push)
    • Code style rules (tabs, Spotless, formatter.xml)
    • Testing expectations (JUnit 5, WireMock, JaCoCo)
    • Developer Certificate of Origin (DCO) guidelines
  • Added .github/PULL_REQUEST_TEMPLATE.md with description, related issue, changes, how to test, and checklist sections
  • Updated README.md contributing section to link to the new CONTRIBUTING.md

How to Test

  1. Verify CONTRIBUTING.md renders correctly on GitHub
  2. Open a new PR to confirm the PR template auto-populates

Checklist

  • I have read the CONTRIBUTING.md guide
  • Code follows the project's style guidelines (mvn spotless:apply)
  • Tests added for new functionality (if applicable) — N/A, docs only
  • All tests pass (mvn clean verify)
  • Documentation updated (if applicable)

- Add CONTRIBUTING.md with setup, code style, testing, and DCO guidelines
- Add .github/PULL_REQUEST_TEMPLATE.md with description, changes, and checklist
- Update README.md contributing section to link to CONTRIBUTING.md

Closes PhonePe#39
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.

Add CONTRIBUTING.md with DCO and PR template

1 participant