From 2ad4554d69ec384bf79b09e05e5958c778a53e10 Mon Sep 17 00:00:00 2001 From: Pavol Rusnak Date: Tue, 12 May 2020 13:57:28 +0200 Subject: [PATCH] docs: better typo in contributing.md --- docs/misc/contributing.md | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/misc/contributing.md b/docs/misc/contributing.md index 8f5dbc791d..1c100f50e0 100644 --- a/docs/misc/contributing.md +++ b/docs/misc/contributing.md @@ -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.