For co-authors (click to expand)
Please follow this structure for your contribution.
-
Place all scripts related to a specific task inside a folder with an appropriately chosen name (e.g.,
genome-assembly
). Use hyphens to separate words and utilize all lowercase letters (if feasible). -
Include a
README.md
file within the folder, explicitly detailing the employed programs, their order in the workflow, necessary inputs, and the corresponding scripts used. -
Create a sub-folder for figures, and store both the source code and the associated
png
/pdf
/tiff
files within it. If the file size is small, you may also put the input data in this sub-folder. -
Place all mentioned scripts from the
README.md
and any input files (with a size smaller than <1Mb) into anassets
sub-directory. Similarly, anything that doesn't qualify as a script or input should also go here. -
After finalizing your section, ensure to link the
README.md
file in the table of contents with an appropriate title for your section. -
Feel free to reach out if you have any questions or suggestions!
- Genome assembly methods
- Quality control
- Gene prediction and annotation
- Repeat annotation
- Orthology prediction
Please check our contributions page for all the authors who worked on this GitHub documentation (and the sections they worked on!).