From 866ff5b35c2f40ccf27bd3d135a332adbd3ed957 Mon Sep 17 00:00:00 2001
From: Remi  PLANEL <rplanel@pasteur.fr>
Date: Mon, 6 Nov 2023 10:36:11 +0100
Subject: [PATCH] Add merge request template for new system

---
 .../new-system-reviewer-guide.md              | 50 +++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 .gitlab/merge_request_templates/new-system-reviewer-guide.md

diff --git a/.gitlab/merge_request_templates/new-system-reviewer-guide.md b/.gitlab/merge_request_templates/new-system-reviewer-guide.md
new file mode 100644
index 00000000..9675df57
--- /dev/null
+++ b/.gitlab/merge_request_templates/new-system-reviewer-guide.md
@@ -0,0 +1,50 @@
+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. 
+It should contain :
+1. Header with the following fields (please pay attention to block indentation)
+---
+title: 
+tableColumns: 
+    article:
+        doi: 
+        abstract: 
+    Sensor: 
+    Activator: 
+    Effector: 
+    PFAM: 
+---
+2. The following paragraphs
+- Description
+- Molecular mechanisms
+- Example of genomic structure
+- 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
+
+[ ] At least one relevant abstract is provided.
\ No newline at end of file
-- 
GitLab