docs: add semver and conv commits to docs

AstroBarker · Feb 14, 2024 · 0126fd6 · 0126fd6
1 parent 73f05bb
commit 0126fd6
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,6 +3,7 @@
 I am happy to receive contributions -- there are certainly places where existing functionality can be improved or extended, or room for new functionality.
 
 The ideal mode for contributing is through pull requests.
+If possible adhere to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit message styling.
 
 Apart from the rest, it's expected to behave appropriately.
 

diff --git a/README.md b/README.md
@@ -53,3 +53,4 @@ Rules are listed in [ruff.toml](ruff.toml).
 To check all python in the current directory, you may `ruff .`.
 To format a given file according to `ruff.toml`, run `ruff format file.py`.
 Checks for formatting are performed on each push / PR.
+We (try to) adhere to [semantic versioning](https://semver.org/) and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).