From 83736e1e8fea20ef90de7bf2d4985ffdf88a9bfa Mon Sep 17 00:00:00 2001 From: inexcode Date: Tue, 1 Nov 2022 11:38:37 +0300 Subject: [PATCH] docs: add a pull request section to contributing.md --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8a6b88a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +# SelfPrivacy API contributors guide + +## Commit messages + +We follow [Convetional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. Please read it before commiting. + +Useful plugins for IDEs: + +- [VSCode](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits) +- [IntelliJ](https://plugins.jetbrains.com/plugin/13389-conventional-commit) + +## Code style + +We use [Black]( + https://pypi.org/project/black/ +) for code formatting. Please install it and run `black .` before commiting. + +## Pull requests + +Please request a review from at least one of the other maintainers. If you are not sure who to request, request a review from SelfPrivacy/Devs team.