Files

63 lines
1020 B
Markdown
Raw Permalink Normal View History

# Contributing Guide
2026-05-26 22:15:14 +05:30
Thanks for your interest in improving `pmg`. Beyond bug fixes and features, we particularly value:
- Documentation improvements
- Bug reports
2026-05-26 22:15:14 +05:30
- Using `pmg` in your projects and sharing feedback
2026-05-26 22:15:14 +05:30
## Reporting a bug
2026-05-26 22:15:14 +05:30
Open a new issue with the `bug` label.
2026-05-26 22:15:14 +05:30
## Suggesting a feature
2026-05-26 22:15:14 +05:30
Open a new issue with the `enhancement` label.
## Developer Setup
### Requirements
- Go 1.25+
- Git
- Make
2026-05-26 22:15:14 +05:30
### Getting started
2026-05-26 22:15:14 +05:30
Clone your fork and build:
2025-05-15 18:03:46 +05:30
```shell
git clone https://github.com/YOUR_USERNAME/pmg.git
cd pmg
go mod tidy
make all
```
2026-05-26 22:15:14 +05:30
## Development Workflow
1. Create a branch:
2025-05-15 18:03:46 +05:30
2026-05-26 22:15:14 +05:30
```shell
git checkout -b feature/your-feature
```
2026-05-26 22:15:14 +05:30
2. Make your changes. Add tests for new code.
2025-05-15 18:03:46 +05:30
2026-05-26 22:15:14 +05:30
3. Run the test suite:
2026-05-26 22:15:14 +05:30
```shell
make test
```
2025-05-15 18:03:46 +05:30
2026-05-26 22:15:14 +05:30
4. Commit with a [DCO](https://developercertificate.org/) sign-off (the `-s` flag is required):
2026-05-26 22:15:14 +05:30
```shell
git commit -s -m "feat: add new feature"
```
2025-05-15 18:03:46 +05:30
2026-05-26 22:15:14 +05:30
5. Push and open a pull request:
```shell
git push origin feature/your-feature
```