Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 1.47 KB
Raw

Contributing to pyscreenrec

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to pyscreenrec, which is hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Setup local development environment

This section shows how you can setup your development environment to contribute to pyscreenrec.

  1. Fork the repository.

  2. Clone it using Git (git clone https://github.com/<YOUR USERNAME>/pyscreenrec.git).

  3. Create a virtual environment.

python -m venv venv

Activate it using

./venv/Scripts/Activate.ps1

on Windows

source ./venv/bin/activate

on unix-based systems (make sure to choose the activation script according to your shell)

  1. Install dependencies.

We recommend using poetry for dependency management.

poetry install --no-root

Otherwise, using pip:

pip install .

  1. Make your changes.

  2. Stage and commit (git add . and git commit -m "COMMIT MESSAGE").

  3. Push it your remote repository (git push).

  4. Open a pull request by clicking here.

Reporting Issues

If you know a bug in the code or you want to file a feature request, open an issue.

Choose one of the issue templates by clicking here.