From 6f8bc89a73cb0ac8f010764757764a9ac9231192 Mon Sep 17 00:00:00 2001 From: EagleoutIce Date: Sat, 23 Nov 2024 15:14:40 +0100 Subject: [PATCH] refactor(commitlint): allow new `-fix` comments and update documentation --- .github/.commitlintrc.json | 10 +++++----- .github/CONTRIBUTING.md | 26 +++++++++++++------------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.github/.commitlintrc.json b/.github/.commitlintrc.json index d953dc2727..fd4819aa48 100644 --- a/.github/.commitlintrc.json +++ b/.github/.commitlintrc.json @@ -18,17 +18,17 @@ "scope-empty": [1, "never"], "type-case": [2, "always", "kebab-case"], "type-enum": [2, "always", [ - "build", "build-fix", + "build", "build-fix", "builds", "builds-fix", "ci", "ci-fix", - "doc", "docs", "doc-fix", "docs-fix", + "doc", "doc-fix", "docs", "docs-fix", "feat", "feat-fix", - "perf", + "perf", "perf-fix", "refactor", "test", "tests", "test-fix", "tests-fix", - "dep", + "dep", "dep-fix", "deps", "deps-fix", "lint", "lint-fix", "wip", - "meta" + "meta", "meta-fix" ]], "type-empty": [2, "never"], "signed-off-by": [2, "never", "Signed-off-by:"] diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ea7da617fa..db6887958d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -116,19 +116,19 @@ In general, these commits have the following shape: We support the following commit types: -| name | description | -|:---------------------------------------|----------------------------------------------------------------------------------------------------| -| `build` | Changes that affect the build system or external dependencies (e.g., npm). | -| `ci`, `ci-fix` | Updates or fixes the continuous integration (ci) pipeline of *flowR*. | -| `doc`/`docs`, `doc-fix`/`docs-fix` | Changes that only affect documentation. | -| `feat`, `feat-fix` | Introduces a new feature. | -| `perf` | Improves performance. | -| `refactor` | Represents a refactoring of existing code. | -| `test`/`tests`, `test-fix`/`tests-fix` | Introduces new or modifies existing tests. | -| `dep` | Regards the explicit update of dependencies (or the addition of new dependencies. | -| `lint`, `lint-fix` | Adapts or updates linter-issues. | -| `wip` | *Use this only in combination with another type*. It marks the commit to be unfinished. | -| `meta` | *Use this only if none of the other categories apply*. Explain the details in your commit message. | +| name | description | +|:-------------------------------------------|----------------------------------------------------------------------------------------------------| +| `build`/`builds`, `build-fix`/`builds-fix` | Changes that affect the build system or external dependencies (e.g., npm). | +| `ci`, `ci-fix` | Updates or fixes the continuous integration (ci) pipeline of *flowR*. | +| `doc`/`docs`, `doc-fix`/`docs-fix` | Changes that only affect documentation. | +| `feat`, `feat-fix` | Introduces a new feature. | +| `perf`, `perf-fix` | Improves performance. | +| `refactor` | Represents a refactoring of existing code. | +| `test`/`tests`, `test-fix`/`tests-fix` | Introduces new or modifies existing tests. | +| `dep`/`deps`, `dep-fix`/`deps-fix` | Regards the explicit update of dependencies (or the addition of new dependencies). | +| `lint`, `lint-fix` | Adapts or updates linter-issues. | +| `wip` | *Use this only in combination with another type*. It marks the commit to be unfinished. | +| `meta`, `meta-fix` | *Use this only if none of the other categories apply*. Explain the details in your commit message. | Although we have done that earlier, we do no longer allow more than one type (as enforced by [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)).