Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.43 KB

CONTRIBUTING.rst

File metadata and controls

50 lines (33 loc) · 1.43 KB

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)