Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

77 lines (53 loc) · 3.64 KB
Raw

Contributing

The Galaxy RNA-workbench project welcomes new contributors! This document briefly describes how to contribute to the RNA-workbench.

Before you Begin

If you have an idea for a feature to add or an approach for a bugfix, the most common venues for this are GitHub issues. If you have general Galaxy related questions or want to contribute to Galaxy as a framework join the project at https://github.com/galaxyproject/galaxy. We are are generally available via Gitter or IRC.

Reporting a new issue

If no existing issue seems appropriate, a new issue can be opened using this form.

How to Contribute

  • All changes to the RNA-workbench should be made through pull requests to this repository (with just two exceptions outlined below).

  • If you are new to Git, the Try Git tutorial is a good place to start. More learning resources are listed at https://help.github.com/articles/good-resources-for-learning-git-and-github/ .

  • Make sure you have a free GitHub account.

  • Fork the RNA-workbench repository on GitHub to make your changes. To keep your copy up to date with respect to the main repository, you need to frequently sync your fork:

      $ git remote add upstream https://github.com/bgruening/galaxy-rna-workbench
  $ git fetch upstream
  $ git checkout dev
  $ git merge upstream/dev

  • Commit and push your changes to your fork.

  • Open a pull request with these changes. You pull request message ideally should include:

    • A description of why the changes should be made.

    • A description of the implementation of the changes.

    • A description of how to test the changes.

  • The pull request should pass all the continuous integration tests which are automatically run by GitHub using e.g. Travis CI.

  • Your pull request will be reviewed by the RNA community and merged if a member of the core team approves the changes.

A Quick Note about new Tools, Workflows and Tours

Tools

Galaxy tools should be published to the Tool Shed and specified in our tool list. Our continuous integration tests will build a new workbench with your tool included automatically and will run a few tests to check the integrity.

More information about tool development can be found on the community hub.

Workflows

Galaxy workflows can be contributed by simply putting them into our workflow folder. Our Build infrastructure will deploy this workflow in the RNA-workbench. Please make sure that all tools needed for the workflow are integrated into the RNA-workbench. If not please add these tools beforehand.

Tours

Galaxy interactive tours can be contributed by simply putting them into our tours folder. Our Build infrastructure will deploy all tours in this folder in the RNA-workbench.