Summary
A contribution guide should be added.
The Problem
Currently it's not 100% clear on how to setup a dev environment for pull requests. But it also might not be on how to report issues.
The Ideal Solution
We should mention everything important on how to setup a dev env and then create proper PRs.
This includes:
- Cloning repo
- Installing dev requirements (
pip install -U .[dev])
- Installing pre-commit hook (
pre-commit install)
- How to get started with testing.
We might also include some details for proper bug reporting.
The Current Solution
No response
Additional Context
No response
Summary
A contribution guide should be added.
The Problem
Currently it's not 100% clear on how to setup a dev environment for pull requests. But it also might not be on how to report issues.
The Ideal Solution
We should mention everything important on how to setup a dev env and then create proper PRs.
This includes:
pip install -U .[dev])pre-commit install)We might also include some details for proper bug reporting.
The Current Solution
No response
Additional Context
No response