Add local build script #269
Labels
good first issue
Good for newcomers
topic: build
Anything relating to the build system.
type: development
Work to ease development or maintenance, without direct effect on features or bugs
We have a comprehensive CI build now that checks quite a few things. This is good and necessary, but I know from experience, that it can also be a pain for new contributors. You don't know what the CI build checks for yet, so you don't know what to pay attention to. Since CI builds are not instant, it can be a pain to fix your broken build.
Experienced contributors also benefit from an easy way to check the most relevant things locally, before pushing a pull request.
Ideally, this local build would not duplicate what the CI build already does, but due to the way the CI build is structured, this is not practical. And it doesn't matter much, as there are only a few things that are checked. Duplicating those in a local build script is totally fine.
Here's what this build script should do:
cargo clippy
cargo test
cargo fmt --check
This is rather straight-forward. The question is, what should this build script be, as it needs to work on many platforms. @Bandsberg suggested Nushell in #64 (comment), but there are many possibilities.
Labeling https://github.com/hannobraun/Fornjot/labels/good%20first%20issue, as this is rather self-contained and doesn't require knowledge of Fornjot.
The text was updated successfully, but these errors were encountered: