docs: add pre-commit starter guide

xonsh · Mar 16, 2023 · ffec8ae · ffec8ae
1 parent 6b61855
commit ffec8ae
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/project-template/{{ project_repo_name }}/README.md b/project-template/{{ project_repo_name }}/README.md
@@ -39,6 +39,16 @@ xontrib load {{project_package_name}}
 
 ...
 
+## Development
+{% if enable_pre_commit_hooks %}
+- activate [pre-commit](https://github.com/pre-commit/pre-commit) hooks
+```sh
+# install pre-commit plugins and activate the commit hook 
+pre-commit install
+pre-commit autoupdate
+```
+{% endif %}
+
 ## Releasing your package
 
 - Bump the version of your package.