How to contribute to this project

The OH sequencing for surveillance handbook project is an open documentation project, and we welcome all contributions to this handbook.

Contributor Agreement

By contributing, you agree that we may redistribute your work under the license that this project uses. In return, you will be recognized as a contributor to this project, which will be reflected in the AUTHORS document in this repo. We expect all contributors to abide by the project’s code of conduct.

How to contribute

The easiest way to get started is to file an issue to tell us about a spelling mistake, some awkward wording, or a factual error. If you do not have a GitHub account, you can send us comments by email to ngs-handbook@groups.io. However, we will be able to respond more quickly if you use one of the other methods described below. If you have a GitHub account, or are willing to create one, but do not know how to use Git, you can report problems or suggest improvements by creating an issue. This allows us to assign the item to someone and to respond to it in a threaded discussion. If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR). Instructions for doing this are included below.

What to contribute

We are very happy to receive any and all contributions regarding the subject matter of this handbook in whichever manner you are able to submit them. Many different things can be contributed, you can send us an email about relevant reports, you can submit an issue informing about an error you found, or you can submit a pull request contributing text on a new method or a procedure.

Using Github.

If you choose to contribute via GitHub, you may want to look at How to Contribute to an Open Source Project on GitHub.The current version of the handbook is to be found in the master branch. Contributions to this will be checked by the editors before being added to the documentation.

How to proceed:

  • Fork (i.e. copy) the project to your account
  • Go to your fork.
  • Then add/modify the contents you want. This can be done directly in your fork on github. We use mostly markdown format.
  • Commit the change.
  • Send your pull request.
  • Your pull request will manually checked, and merged into the documentation
  • The documentation will then be auto-rebuilt, and your change will be available.