Permalink
Fetching contributors…
Cannot retrieve contributors at this time
32 lines (22 sloc) 1.93 KB

Sarek Contributing Guidelines

Hi there! Many thanks for taking an interest in improving Sarek.

We try to manage the required tasks for Sarek using GitHub issues, you probably came to this page when creating one. Please use the prefilled template to save time.

However, don't be put off by this template - other more general issues and suggestions are welcome! Contributions to the code are even more welcome ;)

If you need help using Sarek then the best place to go is the Gitter chatroom where you can ask us questions directly: https://gitter.im/SciLifeLab/Sarek

Contribution workflow

If you'd like to write some code for Sarek, the standard workflow is as follows:

  1. Check that there isn't already an issue about your idea in the Sarek issues to avoid duplicating work.
  2. Fork the Sarek repository to your GitHub account
  3. Configure a remote for your fork
git remote add upstream https://github.com/SciLifeLab/Sarek.git
  1. Sync your fork
  2. Make the necessary changes / additions within your forked repository
  3. Submit a Pull Request against the dev branch and wait for the code to be reviewed and merged.

If you're not used to this workflow with git, you can start with some basic docs from GitHub or even their excellent interactive tutorial.

For further information/help, please consult the Sarek documentation and don't hesitate to get in touch on Gitter or contact us: maxime.garcia@scilifelab.se, szilveszter.juhos@scilifelab.se