SelfPrivacy/selfprivacy-rest-api
1
0
Fork 0
mirror of https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api.git synced 2025-01-11 18:39:30 +00:00
Code Issues Projects Releases Wiki Activity

docs: add a pull request section to contributing.md

Browse source
This commit is contained in:
inexcode 2022-11-01 11:38:37 +03:00
parent 19a4ec5377
commit 83736e1e8f
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CONTRIBUTING.md Normal file
View file

@ -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.