2020-04-30 12:49:33 +00:00
|
|
|
# Contribute to Trezor Firmware
|
|
|
|
|
|
2020-05-12 11:57:28 +00:00
|
|
|
Please read the general instructions you can find on our
|
|
|
|
|
[wiki](https://wiki.trezor.io/Developers_guide:Contributing).
|
2020-04-30 12:49:33 +00:00
|
|
|
|
2020-05-12 11:57:28 +00:00
|
|
|
Your Pull Request should follow these criteria:
|
2020-04-30 12:49:33 +00:00
|
|
|
|
|
|
|
|
- The code is properly tested.
|
|
|
|
|
- Tests must pass on [CI](https://travis-ci.org/trezor/trezor-firmware).
|
2020-05-12 11:57:28 +00:00
|
|
|
- The code is properly formatted. Use `make style_check` to check the format
|
|
|
|
|
and `make style` to do the required changes.
|
|
|
|
|
- The generated files are up-to-date. Use `make gen` in repository root to make
|
|
|
|
|
it happen.
|
2020-10-16 07:16:17 +00:00
|
|
|
- Commits must have concise commit messages, we endorse [Conventional Commits](https://www.conventionalcommits.org).
|
2021-04-19 11:32:52 +00:00
|
|
|
- A [changelog entry](changelog.md) must be part of the pull request.
|
2020-10-16 07:16:17 +00:00
|
|
|
|
2020-10-21 12:40:34 +00:00
|
|
|
### Please read and follow our [review procedure](review.md).
|
