Skip to content

Commit

Permalink
docs(setup): developer setup instructions to run codebase
Browse files Browse the repository at this point in the history
  • Loading branch information
andimiya committed Sep 27, 2024
1 parent 884ee1e commit e3d639a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit e3d639a

Please sign in to comment.