Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(commitlint): allow new -fix comments and update documentation #1170

Merged
merged 1 commit into from
Nov 23, 2024
Merged

refactor(commitlint): allow new -fix comments and update documentation #1170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/.commitlintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:"]
Expand Down
26 changes: 13 additions & 13 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/)).
Expand Down
Loading