Skip to content

Commit

Permalink
Adding gsid repo
Browse files Browse the repository at this point in the history
  • Loading branch information
konkapv committed May 29, 2013
1 parent 540af0a commit 423e7a0
Show file tree
Hide file tree
Showing 4 changed files with 454 additions and 0 deletions.
86 changes: 86 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
=================
How to Contribute
=================

We welcome community contributions to the caBIO project.
Your contributions back to this repository will allow the broader
research community to benefit from your work and will allow your
enhancements to be integrated with those of others. There are a few
guidelines that we ask contributors to follow so that we can have a
chance of keeping on top of things.

---------------
Getting Started
---------------

* Make sure you have a `GitHub Account`_.

* Fork the repository on GitHub to publish any proposed changes

.. If a project uses a tracker, then:
* Submit a ticket for your issue at https://tracker.nci.nih.gov/browse/CABIO,
assuming one does not already exist.

- Click on https://tracker.nci.nih.gov/secure/CreateIssue.jspa?pid=10002&issuetype=8 to get a jira account.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.

.. _`GitHub Account`: https://github.com/signup/free

--------------
Making Changes
--------------

* Create a topic branch from where you want to base your work.

- This is usually the master branch.
- Only target release branches if you are certain your fix must be
on that branch.
- To quickly create a topic branch based on master::

git checkout -b fix/master/my_contribution master

Please avoid working directly on the master branch.

* Make commits of logical units.

* Please provide tests and documentation with your changes.

* Check for unnecessary whitespace with ``git diff --check`` before committing.

* Follow the `NCIP Good Practices for Commit Messages`_.
Start with a one-line summary followed by a blank line followed by a
detailed free-form description.

.. _`NCIP Good Practices for Commit Messages`: https://github.com/NCIP/ncip.github.com/wiki/Good-Practices#wiki-commit-messages

------------------
Submitting Changes
------------------

* In general, we require that the OSI-approved `BSD-3-Clause License`_
be applied to code contributions. There may be cases, however, that
warrant the use of an alternate OSI-approved license and we will
evaluate this situations case-by-case.

* Push your changes to a topic branch in your fork of the repository.

* Submit a pull request to the repository in the NCIP organization.

.. If a project uses a tracker, then:
* Update your https://tracker.nci.nih.gov/browse/CABIO ticket to mark that you have submitted
code and are ready for it to be reviewed.

- Include a link to the pull request in the ticket

.. _`BSD-3-Clause License`: http://opensource.org/licenses/BSD-3-Clause

--------------------
Additional Resources
--------------------

For help learning Git and Github, see the `NCIP Learning Resources`_.

.. _`NCIP Learning Resources`: https://github.com/NCIP/ncip.github.com/wiki/Learning-Resources
27 changes: 27 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Copyright (c) 2010, Washington University in St. Louis, SemanticBits, Persistent Systems
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

Neither the name of the National Cancer Institute, SAIC nor the
names of its contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Loading

0 comments on commit 423e7a0

Please sign in to comment.