Skip to content
This repository has been archived by the owner on Mar 26, 2023. It is now read-only.

Commit

Permalink
Docs: Update README.md with development and TODOs
Browse files Browse the repository at this point in the history
  • Loading branch information
benmezger committed May 17, 2020
1 parent 02bbe0e commit 17bddf4
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,22 @@ Finally, install the hook with pre-commit: `pre-commit install --hook-type prepa

Run `pre-commit uninstall --hook-type prepare-commit-msg`. That should disable
`prepare-commit-msg`.

## Development

1. Install requirements
`pip install -r requirements.txt`
2. Run `pytest`
`pytest .`

There are two ways of manually running GJira.

1. `python -m gjira` which will run `main()` in `__main__`
2. Installing the cli to your system
`pip install .`

## TODO

- Check if issue is in commit when running `git ammend` and don't re-append
- Cache issues the board and check the cache before doing a HTTP request
- add `--refresh` parameter to GJira

0 comments on commit 17bddf4

Please sign in to comment.