This repository contains the manuscript entitle: Ten Simple Rules for taking advantage of GitHub in bioinformatics. Our main aim here is to highlight specific GitHub features that enable the bioinformatics community to use GitHub features and tools on a daily basics. We will then provide a set of recommendations for taking full advantage of its core features to facilitate and manage the work on a given bioinformatics project and increase its profile to the scientific community. We think the manuscript is timely due to the announcement of the closure of another widely used service, Google Code. Therefore, many of the users of Google Code will therefore have to migrate to GitHub.
If you have an idea for a new Rule to add or change to the main manuscript or Figure, etc, it is best to communicate with the authors of the paper. The most common venues for this are GitHub issues for common specification issues. Browse through existing GitHub 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.
All changes to the manuscript should be made through pull requests to this repository.
If you are new to Git, the Try Git tutorial is a good places to start. More learning resources are available here.
-
Create a GitHub account and log in.
-
Fork the paper repository on GitHub to make your changes.
-
Choose the correct branch to develop your changes against or create a new one (this is typically
master). -
Serious problems or major changes should not be fixed via pull request - please open an issue an specifically tag
@ypriverolto discuss such changes beforehand. -
Commit and push your changes to your fork.
-
Open a pull request with these changes. You pull request message ideally should include:
- A motivation of why the changes should be made.
- A brief description of the changes.
-
The pull request should be reviewed and merge by another member of the paper.
The authors have no affiliation with GitHub, nor any commercial entity mentioned in this articel. The views described here reflect our owns without any input from any third party organisation.