Contributing

We designed MetaRefSGB to allow everyone to contribute to the project, not only from a software development perspective, but also in expanding the set of MAGs and Reference Genomes that are processed and organised in SGBs and compose the MetaRefSGB database.

We rely on the pull-request (PR) mechanism for the submission of new update requests. Submission are always composed by a single YAML file with the description of the new MAGs and Reference Genome that will be processed by MetaRefSGB in addition to other descriptive information about the submitted datasets, bibliographic references, and a reference maintainer.

PRs must be submitted to MetaRefSGB-db.

Once submitted, the PR will be reviewed by one of the MetaRefSGB maintainers and, if accepted, will be merged into the updates area of the MetaRefSGB-db repository.

Have a look this model to start building your own YAML update request definition file.

Of course, submitting just a YAML file is not enough to start updating the database. Once the update request has been accepted for merging, the maintainer of the PR will be granted for accessing a temporary space on the CIBIO FTP storage in order to share all the involved genomes with the MetaRefSGB maintainers. They can be then quality-controlled, dereplicated, and finally clustered and organised into SGBs.