Skip to content

Latest commit

 

History

History
129 lines (82 loc) · 3.46 KB

CONTRIBUTING.rst

File metadata and controls

129 lines (82 loc) · 3.46 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 at https://github.com/olivierbinette/pycache/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" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

pycache could always use more documentation, whether as part of the official pycache 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/olivierbinette/pycache/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 pycache for local development.

  1. Fork the pycache repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/pycache.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

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

  4. Create a branch for local development:

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

    Now you can make your changes locally.

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

    $ flake8 pycache tests
$ pytest

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

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

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

  7. Submit a pull request to the dev branch 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. CHANGELOG.rst should be updated.
  3. The pull request should be for the dev branch.

Releasing a new version

To release a new version, create a new pull request on the release branch. Check that it meets these guidelines:

  1. Version has been updated in setup.py following semantic versioning rules.
  2. Changelog has been updated and unreleased changes are now listed under the new version tag.

Tips

  • The file environment.yml provides a development environment for the package:

    conda env create -f environment.yml
conda activate pycache

  • The makefile provides convenient macros to install locally, generate the README.md file, and build the docs:

    make
make install
make README.md
make docs

  • Test the package using pytest:

    pytest