Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: developer setup instructions to run codebase #385

Merged
merged 4 commits into from
Sep 27, 2024
Merged

docs: developer setup instructions to run codebase #385

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e3d639a
docs(setup): developer setup instructions to run codebase
andimiya Sep 27, 2024
4735df7
docs(setup): Prettier updates
andimiya Sep 27, 2024
a6eef8c
docs(setup): Language update
andimiya Sep 27, 2024
9a6421f
docs(setup): Prettier update
andimiya Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down