From 8956d5bc53a0b1f9dd944fd18df73d737d9097bf Mon Sep 17 00:00:00 2001 From: Brendan Le Glaunec Date: Mon, 2 Mar 2026 19:57:19 +0100 Subject: [PATCH] docs: more precisions in contributing guide --- CONTRIBUTING.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e992dd4..7ce01d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,13 +22,37 @@ make test ## Formatting and linting -Run `gofmt` on changed files. Keep code idiomatic and consistent with existing style. +By default, follow the [Uber Go Style Guide](https://github.com/uber-go/guide) and the guidelines from [Effective Go](https://go.dev/doc/effective_go). ```bash make fmt ``` +### Dependency for linting + +* golangci-lint + * see current version defined in `.github/workflows/test.yaml` at `jobs.tests.steps.["Run linter"]` + * configured in `.golangci.yml` + +```bash +make lint +``` + +## Commit messages and PR titles + +Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages and pull request titles. + +- Use the format: `type: subject` +- Write the subject in imperative mood: `add`, `update`, `remove`, `fix`, `refactor` +- Do not use gerunds in subjects: avoid `adding`, `updating`, `removing` + +Examples: + +- `feat: add RTSP timeout flag` +- `fix: remove duplicate progress line` +- `docs: update commit message guidelines` + ## Reporting issues Use the issue template in [.github/ISSUE_TEMPLATE.md](.github/ISSUE_TEMPLATE.md). @@ -43,3 +67,4 @@ Only scan authorized targets. 4. Add or update tests when possible. 5. Ensure `make test` passes. 6. Try to bring as much test coverage as possible with your changes. +7. Use a Conventional Commit-style PR title with an imperative subject.