Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

30 lines (24 loc) · 1.39 KB
Raw

Contributing to this repository

Getting started

Before you begin:

Contributions are made to this repo via Issues and Pull Requests (PRs). Make sure to search for existing Issues and PRs before creating your own.

Getting the code and setting up the project

  1. Fork this project
  2. Clone the repository to your machine
  3. Create a separate branch to get started, e.g. for feature feat/branch-name-here or fix fix/fix-name-goes-here
  4. Make sure to create a new virtual environment and activate it:
python3 -m venv venv
source activate venv/bin/activate
  1. Install dependencies: Run from Git
  2. Start the program with debug mode: ./bin/gpodder -v
  3. Make the changes, commit in a branch and push the branch to your fork and then submit a Pull Request.

Linting

To ensure code quality, we recommend you to run the linter before pushing the changes to your repo. In order to do so ensure the necessary packages are installed by executing:

pip3 install pytest-cov minimock pycodestyle isort requests pytest pytest-httpserver

Execute the linter in the root directory (Linux only): make lint unittest. On Windows execute: pycodestyle share src/gpodder tools bin/* *.py