How to contribute
Thank you for your interest in contributing to this effort! These SOPs are published openly with the aim of helping the greater bioinformatics community, so we love to recieve contributions. There are many ways to do so, from reporting typos, issues, suggesting content, … etc.
To make it easier, we created this guide- let’s dive in!
Credit and Contributions
We find it important that all contributors get credit for their work. Along with including your name in the
yml header of your contributed effort, please make sure you also update the authors.yml to include your contact details.
Inner working of the site
Before proposing any changes, test your changes first by building a local copy in your computer and viewing from your own browser as below:
- Clone down the repository (
git clone https://github.com/h3abionet/H3ABionet-SOPs.git)
cdinto the cloned directory
- Assuming Ruby is installed1, at the prompt, simply run
bundle exec jekyll serveto start the preview server
localhost:4000in your browser to preview the site
Split lenghty pages into smaller chunks Create diagrams for SOP pages
- Add authors’ contact details next to the pages they contribute to
Generate pdf files of the SOPs: Requires some commercial license, so not going to happen Integrate with Disqus for easy commenting Add license information to pages Add proper H3ABioNet branding
Jekyll is written in Ruby, and you need it installed for it to function (at least Ruby 2.1.0 is needed). On Ubuntu systems, you may run
ruby -vat the prompt to check Ruby and its installed version. ↩
The Bundler may be installed using:
gem install bundler. On some Ubuntu 16.04 systems, installing the bundler as above (
gem install bundler), may give errors of the form:
ERROR: While executing gem ... (Gem::FilePermissionError). Some useful pointers for handling this case can be found in the stack overflow entries here ↩
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.