Skip to content

Latest commit

 

History

History
41 lines (35 loc) · 1.92 KB

CONTRIBUTING.rst

File metadata and controls

41 lines (35 loc) · 1.92 KB
Raw

Contributing to PyStanfordDependencies

We love pull requests from everyone. By participating in this project, you agree to abide by the thoughtbot code of conduct.

Getting involved

If you're looking for ideas, see the list of known issues, specifically those marked "help-wanted."

Submitting changes

  • Fork, then clone the repo:

    git clone git@github.com:your-username/PyStanfordDependencies.git
  • Make your changes (please include an update to CONTRIBUTORS.rst)
  • Test your code's formatting with flake8 StanfordDependencies and output with nosetests (you will need to install flake8, JPype1, nose, graphviz, and asciitree packages via pip). You'll need some implementation of Java 1.8 to run the tests. Changes should be tested with Python 2.7 and Python 3.4 (both will be tested with Travis CI (see below) if you don't want to create multiple environments). More information is available in the release checklist). If you add new code, please add appropriate testing code as well in tests/. See coveralls for current test coverage. All new code should include at least some test that covers it.
  • Push to your fork and submit a pull request. Travis CI will test your changes on various Python versions.