Skip to content

Latest commit

 

History

History
131 lines (87 loc) · 3.95 KB

CONTRIBUTING.rst

File metadata and controls

131 lines (87 loc) · 3.95 KB

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 to Colin Talbert at [email protected] or on the issues page of the respective online repository where nabatpy is hosted.

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 issues page of the respective online repository where nabatpy is hosted for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the issues page of the respective online repository where nabatpy is hosted for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

nabatpy could always use more documentation, whether as part of the official nabatpy docs or in docstrings.

Submit Feedback

The best way to send feedback is to file an issue at [email protected] or on the issues page of the respective online repository where nabatpy is hosted.

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 nabatpy for local development.

  1. Fork the nabatpy repo.

  2. Clone your fork locally:

    $ git clone <remote url to your forked version of nabatpy>

3. Install your local copy into a virtual environment using virtualenv or conda. If you have virtualenvwrapper installed, this is how you set up your fork for local development:

$ mkvirtualenv nabatpy
$ cd nabatpy/
$ python setup.py develop

If you have conda installed, this is how you set up your fork for local development on Linux or Mac OS X:

$ conda create --name nabatpy
$ source activate nabatpy
$ cd <your-path-to-nabatpy-project/
$ python setup.py develop

If you have conda installed, this is how you set up your fork for local development on Windows:

> conda create --name nabatpy
> activate nabatpy
> cd <your-path-to-nabatpy-project/
> python setup.py develop

  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 nabatpy tests
$ py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  3. Commit your changes and push your branch to the respective online repository where nabatpy is hosted:

    $ 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 respective online repository website where nabatpy is hosted.

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, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4.

Tips

To run a subset of tests:

$ py.test tests/test_<your-awesome-module>.py