Ten Simple Rules for Taking Advantage of git and GitHub

Description

This repository contains the manuscript entitled: Ten Simple Rules for Taking Advantage of git and GitHub. Our aim here is to describe how the bioinformatics community can use GitHub features and tools on a daily basis.

• Pre-print: http://biorxiv.org/content/early/2016/05/13/048744
• In PLoS Computational Biology: http://dx.doi.org/10.1371/journal.pcbi.1004947

Commenting and contributing

We hope to finalise the manuscript and re-submit soon and won't accept any new pull requests. Feel free to open an issue if there is any point you would like to raise or discuss.

We are about to re-submit the manuscript after addressing the reviewers' comments, but would appreciate input from the community by discussing any points through GitHub issues and/or pull requests.

Feel free to browse through existing/past issues and if one seems related, comment on it. If no existing issue seems appropriate, a new issue can be opened to discuss the suggestion. In particular, we would appreciate discussing more substantial changes (for example suggestion of new rules) in a dedicated issue before sending a pull request.

If you are new to Git, read the manuscript and A Quick Introduction to Version Control with Git and GitHub - your input would be most valuable.

If, based on your contribution, you would like to be added as a co-author, please open an issue and provide your name and affiliation and a short description of your contribution or a link to the relevant issue and pull request.

Conversion to PLoS LaTeX

• Any modifications to the text should be made to the manuscript.md file. This file is then converted to LaTeX using pandoc and included in the main tex file.

• Any modification to the title or authors should be made to manuscript-plos.tex, following the syntax defined therein

Then, type

make manuscript-plos.tex

• Only commit manuscript-plos.pdf. Temporary files will be ignored by git; to clean them up:

make clean

Disclaimer

The authors have no affiliation with GitHub, nor any commercial entity mentioned in this article. The views described here reflect our own views without input from any third party organisation.