Contributing Guidelines¶

See contribution-guide.org for the basics on contributing to an open source project.

Reporting an Issue, or Requesting a Feature¶

Any defects and feature requests are managed using GitHub’s issue tracker. If you never opened an issue on GitHub before, consult the Mastering Issues guide.

Before creating a bug report, please read contribution-guide.org’s Submitting Bugs.

Creating a Work Directory¶

First, check out the source:

mkdir -p ~/src
git clone https://github.com/pyroscope/pyrobase.git ~/src/pyrobase
cd $_

You are strongly encouraged to build within a virtualenv, call the provided script bootstrap.sh to create one in your working directory:

PYTHON=python3 ./bootstrap.sh
. .env

Common Development Tasks¶

Here are some common project tasks:

pytest          # Run unit tests
inv docs -o     # Build documentation and show in browser
inv lint        # Check code quality
inv cov         # Run unit tests & show coverage report
tox             # Run unit tests in various test environments (multiple Python versions)

Performing a Release¶

Check for and fix pylint violations:
```
paver lint -m
```
Verify debian/changelog for completeness and the correct version, and bump the release date:
```
dch -r
```
Check Travis CI status at https://travis-ci.org/pyroscope/pyrobase
Remove ‘dev’ version tagging from setup.cfg, and perform a release check:
```
sed -i -re 's/^(tag_[a-z ]+=)/##\1/' setup.cfg
paver release
```

Commit and tag the release:

git status  # check all is committed
tag="v$(dpkg-parsechangelog | grep '^Version:' | awk '{print $2}')"
git tag -a "$tag" -m "Release $tag"

Build the final release and upload it to PyPI:

paver dist_clean sdist bdist_wheel
twine upload dist/*.{zip,whl}