From 79a0f80029e72a372062f88d147d99fbb9bab038 Mon Sep 17 00:00:00 2001
From: Remi PLANEL <rplanel@pasteur.fr>
Date: Mon, 6 Nov 2023 10:46:05 +0100
Subject: [PATCH] update the reviewer template
---
.../new-system-reviewer-guide.md | 48 ++++++++-----------
1 file changed, 21 insertions(+), 27 deletions(-)
diff --git a/.gitlab/merge_request_templates/new-system-reviewer-guide.md b/.gitlab/merge_request_templates/new-system-reviewer-guide.md
index 9675df57..58d7583f 100644
--- a/.gitlab/merge_request_templates/new-system-reviewer-guide.md
+++ b/.gitlab/merge_request_templates/new-system-reviewer-guide.md
@@ -1,8 +1,12 @@
+# MR new system template
+
This is a guide to help you review an article of the wiki. Please check that all the following criteria are met to consider that a page is complete and correct.
-[ ] The article is correctly structured.
+- [ ] The article is correctly structured.
It should contain :
1. Header with the following fields (please pay attention to block indentation)
+
+```yaml
---
title:
tableColumns:
@@ -13,7 +17,11 @@ tableColumns:
Activator:
Effector:
PFAM:
+contributors:
+ - Firstname Lastname
---
+```
+
2. The following paragraphs
- Description
- Molecular mechanisms
@@ -21,30 +29,16 @@ tableColumns:
- Distribution of the system among prokaryotes
- Structure
- Experimental validation
-- Relevant abstracts with the following structure
-::article-doi-list
----
-items:
- - doi:
----
-::
-- References
-
-[ ] The header contains all the required information.
-The information provided in the header is required to display the list of defense systems. The mandatory fields are : ```title:```, ```article```, ```doi```, ```abstract``` and ```PFAM```. Optional fields are ```Sensor```, ```Activator``` and ```Effector```.
-
-[ ] Main title is correct.
-For a defense system, it should simply be the name of the system.
-
-[ ] All the information is provided, correct and understandable.
-Rule of thumb : As a newcommer in the field, does the page provide the essential information in a clear way regarding the system ?
- [ ] Short description of the system
- [ ] Composition of the system
- [ ] Mechanism of action if it is known
- [ ] References to the literature to further explore the defense system
-
-[ ] Links with the database are working.
- [ ] Distribution of the system among prokaryotes
- [ ] Structure display
+- References with the following syntax : `:ref{doi=my-doi}`
-[ ] At least one relevant abstract is provided.
\ No newline at end of file
+- [ ] The header contains all the required information. The information provided in the header is required to display the list of defense systems. The mandatory fields are : `title:`, `article`, `doi`, `abstract` and `PFAM`. Optional fields are `Sensor`, `Activator` and `Effector`.
+- [ ] Main title is correct. For a defense system, it should simply be the name of the system.
+- [ ] All the information is provided, correct and understandable. Rule of thumb : As a newcommer in the field, does the page provide the essential information in a clear way regarding the system ?
+ - [ ] Short description of the system
+ - [ ] Composition of the system
+ - [ ] Mechanism of action if it is known
+ - [ ] References to the literature to further explore the defense system
+- [ ] Links with the database are working.
+ - [ ] Distribution of the system among prokaryotes
+ - [ ] Structure display
+- [ ] At least one relevant abstract is provided.
\ No newline at end of file
--
GitLab