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/paulross/cpip/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

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

  1. Fork the cpip repo on GitHub.

  2. Clone your fork locally:

    $ git clone https://github.com/paulross/cpip.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 cpip
$ cd cpip/
$ 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 cpip tests
$ python setup.py test or py.test
$ tox

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

  6. 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

  7. 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, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, 3.3 to 3.6, and for PyPy. Check https://travis-ci.org/paulross/cpip/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests, for example to test PpLexer.py:

$ pytest -vs tests/unit/test_core/test_PpLexer.py

Release Checklist

In the following example the version we are moving to, in Major.Minor.Patch format, is 0.9.7.

Current version should be something like M.m.(p)rcX, for example 0.9.7rc4.

Increment version

Change the version to M.m.p in these places:

  • setup.cfg
  • setup.py
  • src/cpip/CPIPmain.py
  • src/cpip/__init__.py

In src/cpip/__init__.py change CPIP_VERSION = (0, 9, 7)

Update the history:

  • HISTORY.rst
  • src/cpip/__init__.py

Update any Trove classifiers in setup.py, https://pypi.python.org/pypi?%3Aaction=list_classifiers

Build and Test

Build and test for Python 3.6:

$ . ~/venvs/CPIP36/bin/activate
(CPIP36) $ python setup.py install
(CPIP36) $ python setup.py test

And for Python 2.7

$ . ~/venvs/CPIP27/bin/activate
(CPIP27) $ python setup.py install
(CPIP27) $ python setup.py test

Build the docs HTML to test them, from an environment that has Sphinx:

(Sphinx) $ cd docs
(Sphinx) $ make clean
(Sphinx) $ make html

Commit and Tag

Commit, tag and push:

$ git add .
$ git commit -m 'Release version 0.9.7'
$ git tag -a v0.9.7 -m 'Version 0.9.7'
$ git push
$ git push origin v0.9.7

PyPi

Prepare release to PyPi for Python 3.6:

Build the egg and the source distribution:

(CPIP36) $ python setup.py install sdist

And for Python 2.7

(CPIP27) $ python setup.py install

Check the contents of dist/*, unpack into tmp/ if you want:

$ cp dist/* tmp/
$ cd tmp/
$ unzip cpip-0.9.7-py2.7.egg -d py27egg
$ unzip cpip-0.9.7-py3.6.egg -d py36egg
$ tar -xzf cpip-0.9.7.tar.gz

Release to PyPi, https://pypi.python.org/pypi/cpip:

(CPIP36) $ twine upload dist/*

ReadTheDocs

Build the documentation: https://readthedocs.org/projects/cpip/builds/

Prepare Next Release Candidate

Finally change the version to M.m.(p+1)rc0, in this example 0.9.8rc0 in these places:

  • setup.cfg
  • setup.py
  • src/cpip/CPIPmain.py
  • src/cpip/__init__.py, also change CPIP_VERSION = (0, 9, 8, 'rc0')

Commit and push:

$ git add .
$ git commit -m 'Release candidate v0.9.8rc0'
$ git push