From 64343fe942c777fb0e35f126583c1a41d8e279da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Mon, 5 Feb 2024 09:36:28 +0200 Subject: [PATCH] Spelling fixes --- CHANGELOG.md | 4 ++-- docs/configuration/gitlint_file.md | 2 +- docs/rules/builtin_rules.md | 2 +- docs/rules/user_defined_rules/index.md | 2 +- docs/rules/user_defined_rules/line_and_commit_rules.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 09ec650d..65f64132 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,7 +34,7 @@ This release was primarily focussed on modernizing gitlint's build and test tool - Gitlint now publishes [dev builds on every commit to main](https://jorisroovers.github.io/gitlint/contributing/releases/#dev-builds) ([#429](https://github.com/jorisroovers/gitlint/issues/429)) - Gitlint now publishes a [`latest_dev` docker image](https://hub.docker.com/r/jorisroovers/gitlint/tags?name=latest_dev) on every commit to main ([#451](https://github.com/jorisroovers/gitlint/issues/452)) ([#452](https://github.com/jorisroovers/gitlint/issues/451)) - Dependencies updated - - Many improvements to the [CI/CD worfklows](https://github.com/jorisroovers/gitlint/tree/main/.github/workflows) + - Many improvements to the [CI/CD workflows](https://github.com/jorisroovers/gitlint/tree/main/.github/workflows) - Fixed coveralls integration: [coveralls.io/github/jorisroovers/gitlint](https://coveralls.io/github/jorisroovers/gitlint) - Improve unit test coverage ([#453](https://github.com/jorisroovers/gitlint/issues/453)) - Integration test fixes on windows ([#392](https://github.com/jorisroovers/gitlint/issues/392), [#397](https://github.com/jorisroovers/gitlint/issues/397)) @@ -303,7 +303,7 @@ and [AlexMooney](https://github.com/AlexMooney) for their contributions. - **Breaking change**: The `--commits` commandline flag now strictly follows the refspec format as interpreted by the [`git rev-list `](https://git-scm.com/docs/git-rev-list) command. This means that linting a single commit using `gitlint --commits ` won't work anymore. Instead, for single commits, - users now need to specificy `gitlint --commits ^...`. On the upside, this change also means + users now need to specify `gitlint --commits ^...`. On the upside, this change also means that gitlint will now understand all refspec formatters, including `gitlint --commits HEAD` to lint all commits in the repository. This fixes [#23](https://github.com/jorisroovers/gitlint/issues/23). - **Breaking change**: Gitlint now always falls back on trying to read a git message from a local git repository, only diff --git a/docs/configuration/gitlint_file.md b/docs/configuration/gitlint_file.md index 00b2f75c..65b367c4 100644 --- a/docs/configuration/gitlint_file.md +++ b/docs/configuration/gitlint_file.md @@ -137,7 +137,7 @@ ignore=T1,body-min-length 7. [Python style regex](https://docs.python.org/3/library/re.html) that the commit-msg title must be matched to. Note that the regex can contradict with other rules if not used correctly (e.g. `title-must-not-contain-word`). 8. Merge commits often don't have a body, so by default gitlint will ignore this rule for merge commits to avoid - unncessary violations. + unnecessary violations. 9. This is useful for when developers often erroneously edit certain files or git submodules. By specifying this rule, developers can only change the file when they explicitly reference it in the commit message. 10. [Python style regex](https://docs.python.org/3/library/re.html) that the commit-msg body must match. In this case diff --git a/docs/rules/builtin_rules.md b/docs/rules/builtin_rules.md index 25bed927..fbebdca4 100644 --- a/docs/rules/builtin_rules.md +++ b/docs/rules/builtin_rules.md @@ -47,7 +47,7 @@ Title cannot contain certain words. | Name | Type | Default | gitlint version | Description | | ------- | -------------- | ---------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `words` | `#!python str` | `#!python "WIP"` | [:octicons-tag-24: v0.3.0][v0.3.0] | Comma-separated list of words that should not be used in the title. Matching is case insensitive. Keywords occuring as part of a larger word are not matched (so `#!python "WIPING"` is allowed). | +| `words` | `#!python str` | `#!python "WIP"` | [:octicons-tag-24: v0.3.0][v0.3.0] | Comma-separated list of words that should not be used in the title. Matching is case insensitive. Keywords occurring as part of a larger word are not matched (so `#!python "WIPING"` is allowed). | === ":octicons-file-code-16: .gitlint" diff --git a/docs/rules/user_defined_rules/index.md b/docs/rules/user_defined_rules/index.md index 6a062760..6e9bb7bb 100644 --- a/docs/rules/user_defined_rules/index.md +++ b/docs/rules/user_defined_rules/index.md @@ -65,7 +65,7 @@ $ cat examples/commit-message-1 | gitlint --extra-path examples/ 1: UC2 Body does not contain a 'Signed-off-by Line' # (1) ``` -1. Example output of a user-defined **Signed-off-by** rule. Other violations occuring in +1. Example output of a user-defined **Signed-off-by** rule. Other violations occurring in [examples/commit-message-1](https://github.com/jorisroovers/gitlint/blob/main/examples/commit-message-1) were removed for brevity. diff --git a/docs/rules/user_defined_rules/line_and_commit_rules.md b/docs/rules/user_defined_rules/line_and_commit_rules.md index 032e4b79..f0c3412e 100644 --- a/docs/rules/user_defined_rules/line_and_commit_rules.md +++ b/docs/rules/user_defined_rules/line_and_commit_rules.md @@ -3,7 +3,7 @@ Gitlint has 2 types of user-defined rules for linting commit messages: - `CommitRule`: applied once per commit -- `LineRule`: applied on a line-by line basis (targetting either the commit message title or every line in the commit message body). +- `LineRule`: applied on a line-by line basis (targeting either the commit message title or every line in the commit message body). The benefit of a `CommitRule` is that it allows for more complex checks that span multiple lines and/or checks that should only be done once per commit. Conversely a `LineRule` allows for greater code re-use and implementation simplicity.