arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-11-13 19:18:56 +00:00
Code Issues Releases Wiki Activity

docs: contributing file (#464)

Browse Source
This commit is contained in:
Tomas Susanka 2019-01-19 16:06:13 +01:00 committed by Pavol Rusnak
parent ea775c2750
commit c6f9c04365
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/CONTRIBUTING.md Normal file
View File

@ -0,0 +1,12 @@
# Contribute to Trezor Core
Please read the general instructions you can find on our [wiki](https://wiki.trezor.io/Developers_guide:Contributing).
In this repository your Pull request should follow these criteria:
- The code is properly tested.
- Tests must pass on [CI](https://travis-ci.org/trezor/trezor-core).
- The code is properly formatted. The make command `make style` checks if it is so and you can use `make black` and `make isort` to make it happen.
- Commits must have concise commit messages, the imperative mood is preferred ([rationale](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53)).
- Multiple commits per PR are allowed, but please do not use reverts etc. - use interactive rebase.
Do not use merge (e.g. merge trezor/master into...). Again, use rebase.