Skip to content

Commit

Permalink
Merge pull request #574 from nsoranzo/dev
Browse files Browse the repository at this point in the history
[PROCEDURES] GitHub issues, security email contact and CI testing
  • Loading branch information
dannon committed Aug 15, 2015
2 parents cb15385 + 3df5818 commit 5b2e208
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions CONTRIBUTING.md
Expand Up @@ -13,13 +13,14 @@ deeper discussion of some of these points - please see the

## Before you Begin

If you have an idea for a feature to add or an approach for a bugfix -
If you have an idea for a feature to add or an approach for a bugfix,
it is best to communicate with Galaxy developers early. The most
common venue for this is the [Galaxy Trello
board](https://wiki.galaxyproject.org/Issues). Browse through existing
cards [here](http://bit.ly/gxytrello) and if one seems related comment
on it. If no existing cards seem appropriate, a new issue can be
opened using [this form](http://galaxyproject.org/trello). Galaxy
common venues for this are
[GitHub issues](https://github.com/galaxyproject/galaxy/issues) and the
[Galaxy and Tool Shed Trello boards](https://wiki.galaxyproject.org/Issues).
Browse through existing GitHub issues and Trello cards and if one seems related,
comment on it. If no existing issue/card seems appropriate, a new issue can be
opened using [this form](https://github.com/galaxyproject/galaxy/issues/new). Galaxy
developers are also generally available via
[IRC](https://wiki.galaxyproject.org/GetInvolved#IRC_Channel) and on
the [development mailing list](http://dev.list.galaxyproject.org/).
Expand All @@ -30,28 +31,29 @@ the [development mailing list](http://dev.list.galaxyproject.org/).
should be made through pull requests to this repository (with just two
exceptions outlined below).

* If you are new to Git - please check out the very useful tutorials on the [GitHub training hub](https://training.github.com/kit/)
* If you are new to Git, the [Try Git](http://try.github.com/) tutorial is a good places 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](https://github.com/)
* Make sure you have a free [GitHub](https://github.com/) account.

* Fork the galaxy repository on
[GitHub](https://github.com/galaxyproject/galaxy) to make your changes.
* Fork the [galaxy repository](https://github.com/galaxyproject/galaxy) on
GitHub to make your changes.
(While many Galaxy instances track
[galaxy-dist](https://bitbucket.org/galaxy/galaxy-dist), active development
happens in the galaxy GitHub repository and this is where pull requests
should be made).

* Choose the correct branch to develop your changes against.

* Additions to the code base should be pushed to the `dev` branch (`git
* Additions of new features to the code base should be pushed to the `dev` branch (`git
checkout dev`).

* Most bug fixes to previously release components (things in galaxy-dist)
should be made against the recent `release_XX.XX` branch (`git checkout release_XX.XX`).

* Serious security problems should not be fixed via pull request - please
responsibly disclose these by e-mailing them (with or without patches) to
galaxy-lab@lists.galaxyproject.org. The Galaxy core development team will
galaxy-committers@lists.galaxyproject.org . The Galaxy core development team will
issue patches to public servers before announcing the issue to ensure there
is time to patch and highlight these fixes widely. We will provide you
credit for the discovery when publicly disclosing the issue.
Expand All @@ -77,11 +79,14 @@ the [development mailing list](http://dev.list.galaxyproject.org/).
request](https://help.github.com/articles/creating-a-pull-request/)
with these changes. You pull request message ideally should include:

* A description of why the change should be made.
* A description of why the changes should be made.

* A description of implementation of the change.
* A description of the implementation of the changes.

* A description of how to test the change.
* 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.

## Ideas

Expand All @@ -93,7 +98,7 @@ developers.
## A Quick Note about Tools

For the most part, Galaxy tools should be published to the
[ToolShed](https://wiki.galaxyproject.org/ToolShed) and not in this
[Tool Shed](https://wiki.galaxyproject.org/ToolShed) and not in this
repository directly. If you are looking to supply fixes for migrated
core tools that used to exist in this repository - please checkout
the [tools-devteam](https://github.com/galaxyproject/tools-devteam)
Expand Down

0 comments on commit 5b2e208

Please sign in to comment.