elizabeth-oda / the-heck

A comamnd line corrector inspired by thefuck and built in Rust.

MIT License

15 stars 2 forks source link

Chore: Add CI with GitHub Actions #5

Open elizabeth-oda opened 1 year ago

elizabeth-oda commented 1 year ago

Purpose of this issue

To ensure that code contributions are well-formatted and well-tested, we should use CI tools, specifically GitHub Actions.

What should be addressed

Fail if formatting is incorrect with rustfmt or a similar tool
Fail on warnings with cargo clippy
Fail if unit tests fail
Other recommendations?

jan-krecke commented 1 year ago

I agree, these would be good checks for the CI.

BTW, have you thought about how to handle unit tests? Many functions in heck take a Path or similar, making testing difficult. I guess we could devise some way of them mocking, but I haven't thought about this in detail yet. We could also include some example history files to parse during testing.

elizabeth-oda commented 1 year ago

This has been partially addressed by this PR, but I will keep this issue open until tests are included in the CI.