Contributing¶
Set up dev environment:
cd ~/your/repository/fork # Activate venv if you have one (recommended)
pip install -e .[dev] # Install dev dependencies (e.g. black, mypy, pre-commit)
pre-commit install # Install git pre-commit hooks
Run unit tests with coverage:
py.test --cov=colorpedia --cov-report=html # Open htmlcov/index.html in your browser
Build and test documentation (Colorpedia uses MkDocs):
mkdocs serve # Open http://127.0.0.1:8000 in your browser
You can add new colors here and palettes here. Thank you for your contribution!