summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.rst54
1 files changed, 27 insertions, 27 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 1223359..f4eeb68 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -9,45 +9,45 @@ work for this project.
General Guidelines
------------------
- Commit history:
+Commit history:
- * Try to keep a clean commit history so it is easier to see your changes.
- Keep functional changes and refactorings in separate commits.
+* Try to keep a clean commit history so it is easier to see your changes.
+ Keep functional changes and refactorings in separate commits.
- Commit messages:
+Commit messages:
- * Have a short one line summary of your change followed by as many paragraphs
- of explanation as you need. This is the place to clarify any subtleties you
- have in your implementation, document other approaches you tried that didn't
- end up working, any limitations on your implementation, etc. The most important
- part here is to describe why you made the change you did, not simply what the
- change you made is.
+* Have a short one line summary of your change followed by as many paragraphs
+ of explanation as you need. This is the place to clarify any subtleties you
+ have in your implementation, document other approaches you tried that didn't
+ end up working, any limitations on your implementation, etc. The most important
+ part here is to describe why you made the change you did, not simply what the
+ change you made is.
- Changelog:
+Changelog:
- * Please ensure to update the changelog by adding a new bullet under an Added, Changed,
- Deprecated, Removed, Fixed, or Security section headers under the Unreleased version.
- If any of those sections are not present, feel free to add the one you need. See
- Keep a Changelog if you need guidance on what makes a good entry since this project
- follows those principles.
+* Please ensure to update the changelog by adding a new bullet under an Added, Changed,
+ Deprecated, Removed, Fixed, or Security section headers under the Unreleased version.
+ If any of those sections are not present, feel free to add the one you need. See
+ Keep a Changelog if you need guidance on what makes a good entry since this project
+ follows those principles.
- Tests:
+Tests:
- * Ensure the tests pass: ``poetry run task test`` to run all tests.
+* Ensure the tests pass: ``poetry run task test`` to run all tests.
- * For any significant code changes, there must be tests to accompany them.
- All unit tests are written with ``pytest``.
+* For any significant code changes, there must be tests to accompany them.
+ All unit tests are written with ``pytest``.
- Code Format:
+Code Format:
- * There is a pre-commit pipeline to ensure a standard code format.
- Make sure to install the pre-commit hooks before making any commits
- with ``pre-commit install``.
+* There is a pre-commit pipeline to ensure a standard code format.
+ Make sure to install the pre-commit hooks before making any commits
+ with ``pre-commit install``.
- CI Pipeline:
+CI Pipeline:
- * There is a CI pipeline that is run using Github Actions on commits to master, dev, and on pull requests.
- This pipeline must pass for your changes to be accepted.
+* There is a CI pipeline that is run using Github Actions on commits to master, dev, and on pull requests.
+ This pipeline must pass for your changes to be accepted.
Getting Up & Running
--------------------