Contributing to Pycecream

Suggesting new features / Reporting An Issue

First, check to see if there's an existing issue/pull request for the bug/feature. All issues are at https://github.com/dstarkey23/pycecream/issues and pull reqs are at https://github.com/dstarkey23/pycecream/pull.

If there isn't an existing issue there, please file an issue. The ideal report includes:

A description of the problem/suggestion.
How to recreate the bug (including the version on your python interpreter).
If possible, create a pull request with a (failing) test case demonstrating what's wrong. This makes the process for fixing bugs quicker & gets issues resolved sooner.

First, clone the repo, then cd into the repo.

$ git@github.com:dstarkey23/pycecream.git
$ cd pycecream

create a new virtual environment

$ python3.7 -m venv venv

activate your environment

$ . venv/bin/activate

install the required dependencies

$ pip install -e .[tests]

run tests

$ python setup.py test

serve documentation

$ ./docs/serve_docs.sh

…and view the docs at http://localhost:8000 in your web browser.

🎉 Now you're ready to create a new branch, add a feature or fix a bug, then send us a pull request! 🎉

A good pull request:

Is clear.
Follows the existing style of the code base (PEP-8).
Has comments included as needed.
A test case that demonstrates the previous flaw that now passes with the included patch, or demonstrates the newly added feature.

We adopt the Conventional Commits convention to format commit messages.

We're using Pydocmd to automatically generate docs.