Skip to content

Latest commit

 

History

History
100 lines (62 loc) · 2.14 KB

CONTRIBUTING.rst

File metadata and controls

100 lines (62 loc) · 2.14 KB

GitHub Issues and Pull Requests

Contributions are both welcome and encouraged. With that in mind here are some contribution guidelines.

Bug Reports

  1. Search issues for similiar issue(s). Avoid raising redudant issue reports.
  2. Provide the requested information in the issue template: system information, clear description, and code & config to reproduce the issue.
  3. Consider raising a pull request to fix the bug.

New Features

  1. New features will be considered on a case by case basis. Barrage is and will be focused on battle-hardened "production ready" features. Bleeding edge research ideas will rarely be incorporated.
  2. Please provide a code snippet and or example that demonstrates the use case and the API of the proposed feature

Pull Requests

Development Setup

Please setup your development environment with the following steps:

# Clone the repository
git https://github.com/briannemsick/barrage
cd barrage

# Install the test requiremeents
pip install -e .[tests]

# Setup pre-commit hooks
pre-commit install

Please run lint, type hint, and test before raising a pull request.

lint:

black . --check
flake8 .
isort . --check

type hint:

find . -name "*.py" | xargs mypy

test:

pytest --cov=barrage --cov-config=setup.cfg tests/

To build the Read the Docs locally:

cd docs
pip install -r requirements.txt
make html

Upload to PyPi (project owner only):

python setup.py sdist bdist_wheel
python -m twine upload dist/*

Raising a Pull Request

  1. Please follow the Google Python Style Guide.
  2. All new code requires docstrings, type hints, and tests.
  3. Pull requests should have links to corresponding issues, a label, and a clear concise description.