Skip to content
Snippets Groups Projects
Commit 79a0f800 authored by Remi  PLANEL's avatar Remi PLANEL
Browse files

update the reviewer template

parent 866ff5b3
No related branches found
No related tags found
No related merge requests found
Pipeline #115169 passed with stages
in 6 minutes and 6 seconds
# 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
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment