From e3d639ac36dcae0d22fd862a2dedd87a3b987bc7 Mon Sep 17 00:00:00 2001 From: Andrea Date: Fri, 27 Sep 2024 13:21:21 -0700 Subject: [PATCH 1/4] 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) From 4735df79d1b93c9212f708c819deb98056e74fae Mon Sep 17 00:00:00 2001 From: Andrea Date: Fri, 27 Sep 2024 13:44:04 -0700 Subject: [PATCH 2/4] docs(setup): Prettier updates --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9717bef..d8e6221 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ name: Monthly issue metrics on: workflow_dispatch: schedule: - - cron: "3 2 1 * *" + - cron: '3 2 1 * *' permissions: contents: read @@ -175,17 +175,18 @@ 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 + +- 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 +- Activate virtual env `source .venv/bin/activate` -Install dependencies +- Install dependencies `pip install -r requirements.txt -r requirements-test.txt` -Run tests +- Run tests `make test` -Run linter +- Run linter `make lint` ## License From a6eef8c8ba1a0efe14c16cd5321b870b16c95d06 Mon Sep 17 00:00:00 2001 From: Andrea Date: Fri, 27 Sep 2024 13:44:39 -0700 Subject: [PATCH 3/4] docs(setup): Language update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8e6221..17898c7 100644 --- a/README.md +++ b/README.md @@ -177,7 +177,7 @@ We would ❤️ contributions to improve this action. Please see [CONTRIBUTING.m ### Development Setup - Ensure you have python `3.10+` installed -- Clone this repo and cd into `issue-metrics` +- Clone this repository and cd into `issue-metrics` - Create python virtual env `python3 -m venv .venv` - Activate virtual env From 9a6421fca09c48718c9c88954bc20eafc6b98e59 Mon Sep 17 00:00:00 2001 From: Andrea Date: Fri, 27 Sep 2024 13:49:44 -0700 Subject: [PATCH 4/4] docs(setup): Prettier update --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 17898c7..6db80bc 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ name: Monthly issue metrics on: workflow_dispatch: schedule: - - cron: '3 2 1 * *' + - cron: "3 2 1 * *" permissions: contents: read