From 3096a5caa6c37f0e6d5067214829e5b988bc35e7 Mon Sep 17 00:00:00 2001
From: Tomas Susanka <tsusanka@gmail.com>
Date: Thu, 30 Apr 2020 14:49:33 +0200
Subject: [PATCH] docs: add PR workflow info; move CONTRIBUTING to docs

---
 CONTRIBUTING.md           | 14 +-------------
 docs/SUMMARY.md           |  1 +
 docs/misc/contributing.md | 21 +++++++++++++++++++++
 3 files changed, 23 insertions(+), 13 deletions(-)
 mode change 100644 => 120000 CONTRIBUTING.md
 create mode 100644 docs/misc/contributing.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index 24d4ccbcb..000000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# Contribute to Trezor Firmware
-
-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-firmware).
-- The code is properly formatted. The make command `make style_check` checks if it is so and you can use `make style` to make it happen.
-- 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.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 120000
index 000000000..5a5630418
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1 @@
+docs/misc/contributing.md
\ No newline at end of file
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index c94573a2a..c9bbeec16 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -34,6 +34,7 @@
 - [Miscellaneous](misc/index.md)
   - [Affected third-parties](misc/third-parties.md)
   - [Coins' BIP-44 Paths](misc/coins-bip44-paths.md)
+  - [Contributing](misc/contributing.md)
   - [FW update and device wipe](misc/update-wipes.md)
   - [Generated Files](misc/generated-files.md)
   - [Git Hooks](misc/git-hooks.md)
diff --git a/docs/misc/contributing.md b/docs/misc/contributing.md
new file mode 100644
index 000000000..8f5dbc791
--- /dev/null
+++ b/docs/misc/contributing.md
@@ -0,0 +1,21 @@
+# Contribute to Trezor Firmware
+
+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-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.