Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 3.68 KB

Contributing to Serratus

Serratus is an Open-Science project. Our aim is to create a 100% reproducible study with 100% transparent and freely available data.

We welcome all scientists and developers to contribute.

Looking for Team Members

To rapidly analyze Earth's virome, we're always looking for talented and enthusiatic people to join!

  • computational and traditional virology
  • phylogenetics
  • viral ecology and zoonosis modeling
  • web-interface development
  • R package development
  • AWS cloud computing

Collaborating with Serratus

Our data is free and available for everyone. If you require assistance with accessing or using Serratus data, please let use know we would love to help. We are set up and capable to run assemblies and retrieve full-length viruses where available. We ask for nothing in return.

Overview

How to Contribute

Find an existing task

To find and solve an open development problem see our Project Page. This is a prioritized list of "Open Tasks" that need to be done, "Tasks in Progress" which are currently being worked on by others, "Code Review" and "Completed Tasks".

Also you can browse all tasks which are organized as "Issues" on github.

Feel free to comment on any issue, even those you're not assigned to if you have a helpful suggestion.

If you'd like to work on a given task, simply add a comment saying this to the issue and it will be "Assigned" to you.

Create a new task

If you have an idea you'd like to develop, would like to run an experiment or require additional documentation, let the other developers know what you're doing by creating an "Issue" on Github. The general template to include initially is:

### Problem / Objective
< Briefly outline a problem you are solving / the research objectives and hypothesis you are testing >

### Proposed Solution / Methods
< How are you planning on solving the problem / experimental design to test the hypothesis >

### Additional Resources
< Outline any additional information you require to do this task or resources you'll need access to >

Authorship guidelines

There is no formal structure to the Serratus team, everyone is encouraged to take full ownership of the components they develop. For publications authorship is determined by the ICMJE Guidelines. Specific emphasis is placed on that authors must be directly involved in the collaboration.

Data Release Policy

To achieve our objective of providing high quality CoV sequence data to the global research effort, Serratus ensures:

  • All software development is open-source and freely available (GPLv3)
  • All sequencing data generated, raw and processed, will be freely available in the public domain in accordance with the Bermuda Principles of the Human Genome Project.