arno/trezor-firmware
1
0
Fork 0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-18 12:28:09 +00:00
Code Issues Releases Wiki Activity

docs: better typo in contributing.md

Browse Source
This commit is contained in:
Pavol Rusnak 2020-05-12 13:57:28 +02:00
parent 25d2d130a0
commit 2ad4554d69
No known key found for this signature in database
GPG Key ID: 91F3B339B9A02A3D
1 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/misc/contributing.md
View File

@ -1,21 +1,26 @@
# Contribute to Trezor Firmware
Please read the general instructions you can find on our [wiki](https://wiki.trezor.io/Developers_guide:Contributing).
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:
Your Pull Request should follow these criteria:
- The code is properly tested.
- Tests must pass on [CI](https://travis-ci.org/trezor/trezor-firmware).
- The code is properly formatted. The make command `make style_check` checks if it is so
and you can use `make style` to do the required changes.
- Generated files are up-to-date. Use `make gen` in repository root 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.
- Do not force push to PRs. If you are implementing some comments from a review use
_fixup_ commits (e.g. `git commit --fixup HEAD`) and push those. After the PR is finally
approved _autosquash_ these commits and force push (`git rebase -i master --autosquash`).
- Do not resolve review comments. Inform the reviewer that you have fixed the issue
(simply comment as "Done" or similar). The reviewer will resolve the discussion after
reviewing your fix.
- 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.
- 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 rebase.
- Do not use merge (e.g. merge trezor/master into ...).
Again, use rebase.
- Do not force push to PRs. If you are implementing some comments from a
review, use _fixup_ commits (e.g. `git commit --fixup HEAD`) and push those.
- After the PR is finally approved _autosquash_ these commits and force push
(`git rebase -i master --autosquash`).
- Do not resolve review comments. Inform the reviewer that you have fixed the
issue (simply by commenting "Done" or similar). The reviewer will resolve the
discussion after reviewing your fix.