docs: fix typo

Author: Lee-W

CHANGELOG.md

@@ -181,7 +181,7 @@
 
 ### Fix
 
-- **bump.py**: `CHANGELOG.md` gets git added and commited correctly
+- **bump.py**: `CHANGELOG.md` gets git added and committed correctly
 
 ## v2.33.0 (2022-09-15)
 
@@ -420,8 +420,8 @@
 
 ### Fix
 
-- **bump**: raise non zero error code when there's no elegible commit to bump
-- **bump**: raise non zero error code when there's no elegible commit to bump
+- **bump**: raise non zero error code when there's no eligible commit to bump
+- **bump**: raise non zero error code when there's no eligible commit to bump
 
 ## v2.20.3 (2021-12-20)
 
@@ -471,7 +471,7 @@
 
 ### Fix
 
-- **commit**: correct the stage checker before commiting
+- **commit**: correct the stage checker before committing
 
 ## v2.18.0 (2021-08-13)
 
@@ -546,7 +546,7 @@
 
 ### Fix
 
-- **bump**: replace all occurances that match regex
+- **bump**: replace all occurrences that match regex
 - **wip**: add test for current breaking change
 
 ## v2.17.1 (2021-04-08)
@@ -792,7 +792,7 @@
 ### BREAKING CHANGE
 
 - setup.cfg, .cz and .cz.cfg are no longer supported
-- Use "cz verion" instead
+- Use "cz version" instead
 - "cz --debug" will no longer work
 
 ## v1.25.0 (2020-07-26)
@@ -961,7 +961,7 @@
 
 - **commands/changelog**: make changelog_file an option in config
 - **commands/changelog**: exit when there is no commit exists
-- **commands/changlog**: add --start-rev argument to `cz changelog`
+- **commands/changelog**: add --start-rev argument to `cz changelog`
 - **changelog**: generate changelog based on git log
 - **commands/changelog**: generate changelog_tree from all past commits
 - **cz/conventinal_commits**: add changelog_map, changelog_pattern and implement process_commit
@@ -1062,7 +1062,7 @@
 - **cmd**: reimplement how cmd is run
 - **git**: Use GitCommit, GitTag object to store commit and git information
 - **git**: make arguments other then start and end in get_commit keyword arguments
-- **git**: Change get_commits into returning commits instead of lines of messsages
+- **git**: Change get_commits into returning commits instead of lines of messages
 
 ### Feat
 
@@ -1162,7 +1162,7 @@
 
 - **config**: handle empty config file
 - **config**: fix load global_conf even if it doesn't exist
-- **config/ini_config**: replase outdated _parse_ini_settings with _parse_settings
+- **config/ini_config**: replace outdated _parse_ini_settings with _parse_settings
 
 ## v1.10.1 (2019-12-10)
 
@@ -1207,16 +1207,16 @@
 ### Refactor
 
 - **config**: remove has_pyproject which is no longer used
-- **cz/customize**: make jinja2 a custom requirement. if not installed use string.Tempalte instead
+- **cz/customize**: make jinja2 a custom requirement. if not installed use string.Template instead
 - **cz/utils**: rename filters as utils
 - **cli**: add back --version and remove subcommand required constraint
 
 ### Fix
 
-- commit dry-run doesnt require staging to be clean
+- commit dry-run doesn't require staging to be clean
 - correct typo to spell "convention"
 - removing folder in windows throwing a PermissionError
-- **scripts**: add back the delelte poetry prefix
+- **scripts**: add back the delete poetry prefix
 - **test_cli**: testing the version command
 
 ## v1.8.0 (2019-11-12)
@@ -1327,7 +1327,7 @@
 - update given files with new version
 - **config**: new set key, used to set version to cfg
 - support for pyproject.toml
-- first semantic version bump implementaiton
+- first semantic version bump implementation
 
 ### Fix
 
@@ -1386,11 +1386,11 @@
 
 ### Refactor
 
-- **conventionalCommit**: moved fitlers to questions instead of message
+- **conventionalCommit**: moved filters to questions instead of message
 
 ### Fix
 
-- **manifest**: inluded missing files
+- **manifest**: included missing files
 
 ## v0.9.5 (2018-08-24)
 
@@ -1408,7 +1408,7 @@
 
 ### Feat
 
-- **commiter**: conventional commit is a bit more intelligent now
+- **committer**: conventional commit is a bit more intelligent now
 
 ## v0.9.2 (2017-11-11)
 

commitizen/cli.py

@@ -68,7 +68,7 @@
                         "name": "--write-message-to-file",
                         "type": Path,
                         "metavar": "FILE_PATH",
-                        "help": "write message to file before commiting (can be combined with --dry-run)",
+                        "help": "write message to file before committing (can be combined with --dry-run)",
                     },
                     {
                         "name": ["-s", "--signoff"],

commitizen/cz/conventional_commits/conventional_commits.py

@@ -192,7 +192,7 @@ def schema(self) -> str:
 
     def schema_pattern(self) -> str:
         PATTERN = (
-            r"(?s)"  # To explictly make . match new line
+            r"(?s)"  # To explicitly make . match new line
             r"(build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)"  # type
             r"(\(\S+\))?!?:"  # scope
             r"( [^\n\r]+)"  # subject

commitizen/cz/utils.py

@@ -1,11 +1,11 @@
 from commitizen.cz import exceptions
 
 
-def required_validator(ans, msg=None):
-    if not ans:
+def required_validator(answer, msg=None):
+    if not answer:
         raise exceptions.AnswerRequiredError(msg)
-    return ans
+    return answer
 
 
-def multiple_line_breaker(ans, sep="|"):
-    return "\n".join(line.strip() for line in ans.split(sep) if line)
+def multiple_line_breaker(answer, sep="|"):
+    return "\n".join(line.strip() for line in answer.split(sep) if line)

commitizen/git.py

@@ -216,7 +216,7 @@ def get_eol_style() -> EOLTypes:
     # We enumerate the EOL types of the response of
     # `git config core.eol`, and map it to our enumration EOLTypes.
     #
-    # It is just like the varient of the "match" syntax.
+    # It is just like the variant of the "match" syntax.
     map = {
         "lf": EOLTypes.LF,
         "crlf": EOLTypes.CRLF,

docs/README.md

@@ -19,14 +19,14 @@
 
 Commitizen is release management tool designed for teams.
 
-Commitizen assumes your team uses a standard way of commiting rules
+Commitizen assumes your team uses a standard way of committing rules
 and from that foundation, it can bump your project's version, create
 the changelog, and update files.
 
 By default, commitizen uses [conventional commits][conventional_commits], but you
 can build your own set of rules, and publish them.
 
-Using a standarized set of rules to write commits, makes commits easier to read, and enforces writing
+Using a standardized set of rules to write commits, makes commits easier to read, and enforces writing
 descriptive commits.
 
 ### Features

docs/bump.md

@@ -184,7 +184,7 @@ will be sent to the stdout, and any other message generated by the bump will be
 sent to stderr.
 
 If `--changelog` is not used with this command, it is still smart enough to
-understand that the user wants to create a changelog. It is recommened to be
+understand that the user wants to create a changelog. It is recommended to be
 explicit and use `--changelog` (or the setting `update_changelog_on_bump`).
 
 This command is useful to "transport" the newly created changelog.
@@ -484,7 +484,7 @@ release. During execution of the script, some environment variables are availabl
 | `CZ_POST_CURRENT_VERSION`      | Current version, after the bump                             |
 | `CZ_POST_CURRENT_TAG_VERSION`  | Current version tag, after the bump                         |
 | `CZ_POST_MESSAGE`              | Commit message of the bump                                  |
-| `CZ_POST_INCREMENT`            | Whether this wass a `MAJOR`, `MINOR` or `PATH` release      |
+| `CZ_POST_INCREMENT`            | Whether this was a `MAJOR`, `MINOR` or `PATH` release      |
 | `CZ_POST_CHANGELOG_FILE_NAME`  | Path to the changelog file, if available                    |
 
 ```toml

docs/contributing.md

@@ -20,7 +20,7 @@ If you're a first-time contributor, you can check the issues with [good first is
 5. Check out a new branch and add your modification.
 6. Add test cases for all your changes.
    (We use [CodeCov](https://codecov.io/) to ensure our test coverage does not drop.)
-7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commmits][conventional-commmits]
+7. Use [commitizen](https://github.com/commitizen-tools/commitizen) to do git commit. We follow [conventional commits][conventional-commits]
 8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
 9. Optionally, update the `README.md`.
 9. **Do not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.

docs/customization.md

@@ -149,7 +149,7 @@ commitizen:
 
 | Parameter           | Type   | Default | Description                                                                                                                                                                                                                      |
 | ------------------- | ------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `questions`         | `Questions` | `None`  | Questions regarding the commit message. Detailed below. The type `Questions` is an alias to `Iterable[MutableMapping[str, Any]]` which is definied in `commitizen.defaults`. It expects a list of dictionaries. |
+| `questions`         | `Questions` | `None`  | Questions regarding the commit message. Detailed below. The type `Questions` is an alias to `Iterable[MutableMapping[str, Any]]` which is defined in `commitizen.defaults`. It expects a list of dictionaries. |
 | `message_template`  | `str`  | `None`  | The template for generating message from the given answers. `message_template` should either follow [Jinja2][jinja2] formatting specification, and all the variables in this template should be defined in `name` in `questions` |
 | `example`           | `str`  | `None`  | (OPTIONAL) Provide an example to help understand the style. Used by `cz example`.                                                                                                                                                |
 | `schema`            | `str`  | `None`  | (OPTIONAL) Show the schema used. Used by `cz schema`.                                                                                                                                                                            |

docs/exit_codes.md

@@ -33,4 +33,4 @@ These exit codes can be found in `commitizen/exceptions.py::ExitCode`.
 | GitCommandError             | 23        | Unexpected failure while calling a git command                                                              |
 | InvalidManualVersion        | 24        | Manually provided version is invalid                                                                        |
 | InitFailedError             | 25        | Failed to initialize pre-commit                                                                             |
-| VersionProviderUnknown      | 26        | `version_provider` setting is set to an unknown version provider indentifier                                |
+| VersionProviderUnknown      | 26        | `version_provider` setting is set to an unknown version provider identifier                                |

docs/tutorials/auto_prepare_commit_message.md

@@ -12,7 +12,7 @@ use a [prepare-commit-msg Git hook](prepare-commit-msg-docs):
 > This hook is invoked by git-commit right after preparing the
 > default log message, and before the editor is started.
 
-To automatically perform arbitrary cleanup steps after a succesful commit you can use a
+To automatically perform arbitrary cleanup steps after a successful commit you can use a
 [post-commit Git hook][post-commit-docs]:
 
 > This hook is invoked by git-commit. It takes no parameters, and is invoked after a

tests/commands/test_check_command.py

@@ -42,7 +42,7 @@
     "docs(check): fix pre-commit setup",
     "bump: version 1.16.1 → 1.16.2",
     "Merge pull request #135 from Lee-W/fix-pre-commit-hook\n\nFix pre commit hook",
-    "docs(check): enforce cz check only whem committing",
+    "docs(check): enforce cz check only when committing",
     (
         'Revert "fix(pre-commit): set pre-commit check stage to commit-msg"\n\n'
         "This reverts commit afc70133e4a81344928561fbf3bb20738dfc8a0b."

tests/commands/test_init_command.py

@@ -155,7 +155,7 @@ def default_choice(request, mocker: MockFixture):
 
 def check_cz_config(config: str):
     """
-    Cehck the content of commitizen config is as expected
+    Check the content of commitizen config is as expected
 
     Args:
         config: The config path