Skip to content

Commit

Permalink
Merge pull request #43 from sandialabs/conventional-commits-guidelines
Browse files Browse the repository at this point in the history
docs: Rework Conventional Commits guidelines
  • Loading branch information
jmgate authored Apr 29, 2024
2 parents 087237e + 6ef601f commit cd088ff
Showing 1 changed file with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,6 @@ pre-commit install --hook-type commit-msg --hook-type pre-push

The checks we perform are the following:
* Use [ruff][ruff] to lint and format the code and docstrings.
* Use [commitizen][commitizen] to ensure commit messages match the
[Conventional Commits specification][conventional]. Use the
[Conventional Commits extension for VS Code][extension] (or something
similar) to create commit messages that match the standard.
* Use [mypy][mypy] to run static type checking on our type-hinted code.
* Ensure no large files are added to the repository.
* Ensure files parse as valid Python.
Expand All @@ -91,8 +87,6 @@ The checks we perform are the following:

[ruff]: https://docs.astral.sh/ruff/
[commitizen]: https://github.com/commitizen-tools/commitizen
[conventional]: https://www.conventionalcommits.org/en/v1.0.0/
[extension]: https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits
[mypy]: https://github.com/python/mypy
[typing]: https://docs.python.org/3/library/typing.html
[rest]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
Expand Down Expand Up @@ -153,6 +147,7 @@ search for and install them. These are the ones we recommend:
* **Vim:** For when you can't truly leave vi behind (and who would want to?).
* **vscode-icons:** Icons for the file explorer.

[conventional]: https://www.conventionalcommits.org/en/v1.0.0/
[kraken]: https://www.gitkraken.com/

**Python-Specific**
Expand Down Expand Up @@ -470,13 +465,9 @@ name would be `123-implement-awesome-new-feature`.
### As Work Continues

Do whatever work is necessary to address the issue you're tackling. Break your
work into logical, working commits. Use the
[Conventional Commits extension for VS Code][vscode] (or something similar) to
ensure your commit messages adhere to the
[Conventional Commits specification][conventionalcommits].

[vscode]: https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits
[conventionalcommits]: https://www.conventionalcommits.org/en/v1.0.0/
work into logical, working commits. Use the **Conventional Commits** extension
for VS Code (or something similar) to ensure your commit messages adhere to the
[Conventional Commits specification][conventional].

Feel free to commit and push small chunks early and often and then use `git
rebase -i` to reorganize your commits before sharing.
Expand Down

0 comments on commit cd088ff

Please sign in to comment.