refactor: remove redundant return None

Co-authored-by: Wei Lee <[email protected]>

Author: josix

commitizen/commands/commit.py

@@ -75,7 +75,7 @@ def prompt_commit_questions(self) -> str:
 
         return message
 
-    def force_edit(self, message: str) -> str:
+    def manual_edit(self, message: str) -> str:
         editor = git.get_core_editor()
         if editor is None:
             raise RuntimeError("No 'editor' value given and no default available.")
@@ -95,7 +95,7 @@ def force_edit(self, message: str) -> str:
     def __call__(self):
         dry_run: bool = self.arguments.get("dry_run")
         write_message_to_file: bool = self.arguments.get("write_message_to_file")
-        force_edit: bool = self.arguments.get("edit")
+        manual_edit: bool = self.arguments.get("edit")
 
         is_all: bool = self.arguments.get("all")
         if is_all:
@@ -122,8 +122,8 @@ def __call__(self):
         else:
             m = self.prompt_commit_questions()
 
-        if force_edit:
-            m = self.force_edit(m)
+        if manual_edit:
+            m = self.manual_edit(m)
 
         out.info(f"\n{m}\n")
 

docs/contributing.md

@@ -22,7 +22,7 @@ If you're a first-time contributor, you can check the issues with [good first is
    (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 commits](https://www.conventionalcommits.org/).
 8. Run `./scripts/format` and `./scripts/test` to ensure you follow the coding style and the tests pass.
-9. Optionally, update the `./docs/README.md`.
+9. Optionally, update the `./docs/README.md` or `docs/images/cli_help` (through running `scripts/gen_cli_help_screenshots.py`).
 9. **Do not** update the `CHANGELOG.md`, it will be automatically created after merging to `master`.
 10. **Do not** update the versions in the project, they will be automatically updated.
 10. If your changes are about documentation. Run `poetry run mkdocs serve` to serve documentation locally and check whether there is any warning or error.