diff --git a/README.md b/README.md index 11f6f8b..6db80bc 100644 --- a/README.md +++ b/README.md @@ -174,6 +174,21 @@ This action can be configured to authenticate with GitHub App Installation or Pe We would ❤️ contributions to improve this action. Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for how to get involved. +### Development Setup + +- Ensure you have python `3.10+` installed +- Clone this repository and cd into `issue-metrics` +- Create python virtual env + `python3 -m venv .venv` +- Activate virtual env + `source .venv/bin/activate` +- Install dependencies + `pip install -r requirements.txt -r requirements-test.txt` +- Run tests + `make test` +- Run linter + `make lint` + ## License [MIT](LICENSE)