Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1017 Bytes

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 1017 Bytes

How to contribute to Good First Issues

Thank you for considering contributing to Good First Issues!

Submitting Updates

Include the following in your patch:

  • Use Ruff to lint and format your code. This and other tools will run automatically if you install pre-commit using the instructions below.

  • Update README.md about new changes if it affects the sub-commands.

  • Use mypy to check static typing on the codebase.

First time setup

  • Clone the repo locally.
git clone https://github.com/yankeexe/good-first-issues
  • Create a virtualenv
python3 -m venv venv

# activate virtualenv
source venv/bin/activate

Install Good First Issues in editable mode with development dependencies.

pip install -e .[dev]

Install the pre-commit hooks.

pre-commit install

Run manually:

pre-commit run

Start coding 🚀