Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

65 lines (50 loc) · 2.77 KB
Raw

How to Contribute

Third-party inputs, bug reports and patches are essential for keeping cy3sbml great. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Always use the latest released versions of Cytoscape and cy3sbml.

Report an issue

If you have questions, are unsure how things work just ask us.

If you found a bug, problem or issue than submit the issue on github, assuming one does not already exist.

  • 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.
  • Provide information about your operating systems and the version of Java and Cytoscape of the form
Operating System: Linux, Ubuntu 14.04 LTS
Cytoscape: v3.4.0
Java: 1.8.0_101

The Cytoscape and java version can be seen in Cytoscape via Help -> About...

Contribute Code

Getting Started

  • Make sure the issue is not already fixed in the development version, i.e. try to reproduce the issue with the development version
  • Make sure you have a GitHub account
  • Submit the issue on github, assuming one does not already exist.
    • 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.
  • Fork the repository on GitHub

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the develop branch.
    • To quickly create a topic branch based on master; git checkout -b fix/develop/my_contribution master. Please avoid working directly on the master or develop branch.
  • Make commits of logical units.
  • Make sure your commit messages are in the proper format.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.

Making Trivial Changes

For changes of a trivial nature to comments and documentation, it is not always necessary to create a new issue on github. In this case, it is appropriate to start the first line of a commit with '(doc)'.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the cy3sbml repository
  • The core team looks at Pull Requests on a regular basis and merges them with develop

Additional Resources