|
| 1 | +# Contributing to go-relax |
| 2 | + |
| 3 | +Thanks for your interest in contributing to go-relax! |
| 4 | + |
| 5 | +Table of contents |
| 6 | +- How to contribute |
| 7 | +- Reporting bugs |
| 8 | +- Submitting changes (PR workflow) |
| 9 | +- Testing and linting |
| 10 | +- Commit message guidelines |
| 11 | +- Code of conduct |
| 12 | + |
| 13 | +How to contribute |
| 14 | +1. Fork the repository. |
| 15 | +2. Create a branch from master: |
| 16 | + - git checkout -b <your-branch-name> |
| 17 | +3. Make small, focused changes with tests where appropriate. |
| 18 | +4. Run the tests and linters locally (instructions below). |
| 19 | +5. Push your branch to your fork and open a Pull Request against srfrog/go-relax master. |
| 20 | + |
| 21 | +Reporting bugs |
| 22 | +- Open an issue using the Bug Report template. |
| 23 | +- Include: steps to reproduce, expected vs actual behavior, Go version, OS. |
| 24 | + |
| 25 | +Submitting changes (PR workflow) |
| 26 | +- Open a pull request from your fork to srfrog/go-relax master. |
| 27 | +- Use the provided PR template and fill in all checklist items. |
| 28 | +- Keep PRs focused and small where possible. |
| 29 | +- If requested, respond to review comments and push updates to the same branch. |
| 30 | +- If you allow “edits by maintainers” that helps maintainers make small fixes. |
| 31 | + |
| 32 | +Testing and linting (local) |
| 33 | +- Install Go (1.20+ recommended). |
| 34 | +- Run unit tests: |
| 35 | + - go test ./... |
| 36 | +- Run go vet: |
| 37 | + - go vet ./... |
| 38 | +- Run gofmt check: |
| 39 | + - gofmt -l . # should print no files |
| 40 | +- Optional linting (recommended): |
| 41 | + - golangci-lint run |
| 42 | + |
| 43 | +Commit message guidelines |
| 44 | +- Keep a short subject line (<=72 chars). |
| 45 | +- Use the imperative mood: "Fix", "Add", "Remove". |
| 46 | +- Optionally include a longer body explaining why the change is necessary. |
| 47 | +- If you must sign-off, include Signed-off-by: Name <email>. |
| 48 | + |
| 49 | +Code of Conduct |
| 50 | +- Be respectful and constructive in reviews and issues. Maintainers reserve the right to close or redirect contributions that do not follow community standards. |
0 commit comments