Files
pmg/CONTRIBUTING.md
T
a651761636 docs: Update README (#296)
* docs: Update README

* docs: Add diagram for how PMG works

* docs: Updated featured docs

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Abhisek Datta <abhisek.datta@gmail.com>

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Abhisek Datta <abhisek.datta@gmail.com>

* Update README.md

Co-authored-by: Sahil Bansal <bansalsahil315@gmail.com>
Signed-off-by: Abhisek Datta <abhisek.datta@gmail.com>

---------

Signed-off-by: Abhisek Datta <abhisek.datta@gmail.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sahil Bansal <bansalsahil315@gmail.com>
2026-05-26 16:45:14 +00:00

1020 B

Contributing Guide

Thanks for your interest in improving pmg. Beyond bug fixes and features, we particularly value:

  • Documentation improvements
  • Bug reports
  • Using pmg in your projects and sharing feedback

Reporting a bug

Open a new issue with the bug label.

Suggesting a feature

Open a new issue with the enhancement label.

Developer Setup

Requirements

  • Go 1.25+
  • Git
  • Make

Getting started

Clone your fork and build:

git clone https://github.com/YOUR_USERNAME/pmg.git
cd pmg
go mod tidy
make all

Development Workflow

  1. Create a branch:

    git checkout -b feature/your-feature
    
  2. Make your changes. Add tests for new code.

  3. Run the test suite:

    make test
    
  4. Commit with a DCO sign-off (the -s flag is required):

    git commit -s -m "feat: add new feature"
    
  5. Push and open a pull request:

    git push origin feature/your-feature