Skip to content

Latest commit

 

History

History
111 lines (72 loc) · 3.06 KB

CONTRIBUTING.rst

File metadata and controls

111 lines (72 loc) · 3.06 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/bmabey/provenance/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

provenance could always use more documentation, whether as part of the official provenance docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/bmabey/provenance/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up provenance for local development.

  1. Fork the provenance repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/provenance.git

  3. Setup your development environment. Assuming you have conda installed, the following commands can be used to create a development environment:

Initial environment creation

conda env create
source activate provenance-dev
pip install -r requirements.txt
pip install -r test_requirements.txt

Reactivating the environment after it has been created

source activate provenance-dev

  1. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  2. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 provenance tests
$ python setup.py test

  3. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  4. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring. Consider updating a guide or other documentation as well.
  3. The pull request should pass the all the TravisCI builds. https://travis-ci.org/bmabey/provenance/pull_requests