diff --git a/.conform.yaml b/.conform.yaml index 79b0e71..d4d1878 100644 --- a/.conform.yaml +++ b/.conform.yaml @@ -9,10 +9,9 @@ policies: body: required: true dco: true - gpg: false spellcheck: locale: US - maximumOfOneCommit: false + maximumOfOneCommit: true conventional: types: - build diff --git a/.github/workflows/conform.yaml b/.github/workflows/conform.yaml index 41c05b8..ed4caaf 100644 --- a/.github/workflows/conform.yaml +++ b/.github/workflows/conform.yaml @@ -21,3 +21,5 @@ jobs: - name: Conform action uses: talos-systems/conform@v0.1.0-alpha.30 + with: + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6aa1132..50bb096 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,15 @@ # Contributing +## Pull Requests + +All PRs require a single commit. + +Having one commit in a Pull Request is very important for several reasons: +* A single commit per PR keeps the git history clean and readable. + It helps reviewers and future developers understand the change as one atomic unit of work, instead of sifting through many intermediate or redundant commits. +* One commit is easier to cherry-pick into another branch or to track in changelogs. +* Squashing into one meaningful commit ensures the final PR only contains what matters. + ## Developer Certificate of Origin All commits require a [DCO](https://developercertificate.org/) sign-off. diff --git a/Makefile b/Makefile index 0ee2465..2051f28 100644 --- a/Makefile +++ b/Makefile @@ -81,6 +81,10 @@ lint: ## Lint Code unit: ## Unit Tests go test -tags=unit $(shell go list ./...) $(TESTARGS) +.PHONY: conformance +conformance: ## Conformance + docker run --rm -it -v $(PWD):/src -w /src ghcr.io/siderolabs/conform:v0.1.0-alpha.30 enforce + ############ .PHONY: helm-unit