From 465b8205ac809e008e864e0008d67d048e51c9cd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ole=20Kr=C3=BCger?= <ole.kruger@trili.tech>
Date: Fri, 2 Aug 2024 10:49:14 +0100
Subject: [PATCH] Update the MR template for the RISC-V crew

---
 .gitlab/merge_request_templates/riscv.md | 80 ++++++++++++++++++++----
 1 file changed, 67 insertions(+), 13 deletions(-)

diff --git a/.gitlab/merge_request_templates/riscv.md b/.gitlab/merge_request_templates/riscv.md
index 45a3e6e1940f..9bf61c405cd9 100644
--- a/.gitlab/merge_request_templates/riscv.md
+++ b/.gitlab/merge_request_templates/riscv.md
@@ -1,28 +1,82 @@
-<!--
-Thanks you for taking the time to contributing to the Tezos project!
-
-Make sure to read our Contributing guide (https://tezos.gitlab.io/developer/contributing.html) and the Merge process description (https://tezos.gitlab.io/developer/merge_team.html). -->
+<!-- 
+    Link Linear issues using magic words. Examples of these are "Closes RV-XXX", "Part of RV-YYY"
+    or "Relates to RV-ZZZ".
+-->
 
 # What
 
-<!-- Explain what your MR does without going into details. -->
+<!--
+    Summarise the changes in this MR.
+-->
 
 # Why
 
-<!-- Explain the motivation for your work. -->
+<!-- 
+    Explain why this MR is needed.
+-->
 
 # How
 
-<!-- Explain how your MR achieves what it says it does and why it is a good way. -->
-<!-- Discuss possible side-effects and other solutions you have considered. -->
+<!--
+    Explain how the MR achieves its goal. If this is trivial, you may omit it.
+-->
+
+# Manually Testing
+
+```
+make -C src/riscv all
+```
+
+# Benchmarking
+
+<!--
+    Measure the impact on performance of this MR on your machine and the benchmark machine.
+    Fill in the table below.
+-->
+
+|  | `master` | This MR | Improvement |
+|--|----------|---------|-------------|
+| $MyMachine | X.XXX TPS (1/XXX native) | X.XXX TPS (1/XXX native) | XX.XX% |
+| Benchmark Machine | Y.YYY TPS (1/YYY native) | Y.YYY TPS (1/YYY native) | YY.YY% |
 
-# Manually testing the MR
+# Tasks for the Author
 
-<!-- Describe how reviewers and approvers can test this MR. -->
+- [ ] All Linear issues that relate to this MR were linked using magic words (e.g. part of, relates to, closes)
+- [ ] There is no dead code and other spurious artefacts in my changes
+- [ ] All newly introduced public functions, methods and types are documented
+- [ ] Documentation of changed functions, methods and types is up-to-date
+- [ ] There are tests which cover bugs which have been fixed, if any
+- [ ] Reasonable effort has been made towards making CI pass
+- [ ] Performance has been benchmarked and populated in the table above
+- [ ] All the above was completed before assigning this MR to reviewers
 
-<!-- Populate various MR fields. -->
 /label ~riscv
-/assign @ole.kruger @victor-dumitrescu @felix.puscasu1 @thomas.pecseli @anastasia.courtney @emturner
-/assign_reviewer @ole.kruger @victor-dumitrescu @felix.puscasu1 @thomas.pecseli @anastasia.courtney @emturner
+/draft
+/assign me
+
+<details>
+
+<summary>Click to reveal GitLab Commands</summary>
+
+<!--
+    Once the MR is ready, run the following GitLab commands.
+-->
+
+```
+/assign @ole.kruger
+/assign @victor-dumitrescu
+/assign @felix.puscasu1
+/assign @anastasia.courtney
+/assign @emturner
+
+/assign_reviewer @ole.kruger
+/assign_reviewer @victor-dumitrescu
+/assign_reviewer @felix.puscasu1
+/assign_reviewer @anastasia.courtney
+/assign_reviewer @emturner
+
 /unassign me
 /unassign_reviewer me
+```
+
+</details>
-- 
GitLab