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.

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

Spelling fixes #540

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down Expand Up @@ -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 <refspec>`](https://git-scm.com/docs/git-rev-list) command. This means
that linting a single commit using `gitlint --commits <ref>` won't work anymore. Instead, for single commits,
users now need to specificy `gitlint --commits <ref>^...<ref>`. On the upside, this change also means
users now need to specify `gitlint --commits <ref>^...<ref>`. 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
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/gitlint_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/builtin_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/user_defined_rules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/user_defined_rules/line_and_commit_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading