From e3d639ac36dcae0d22fd862a2dedd87a3b987bc7 Mon Sep 17 00:00:00 2001 From: Andrea Date: Fri, 27 Sep 2024 13:21:21 -0700 Subject: [PATCH] docs(setup): developer setup instructions to run codebase --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 11f6f8b..9717bef 100644 --- a/README.md +++ b/README.md @@ -174,6 +174,20 @@ 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 repo 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)