diff options
| author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2020-08-19 13:32:33 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-19 16:32:33 -0400 |
| commit | 4b03b4b0b0a3c716bd834a24e79466586ba9a156 (patch) | |
| tree | 93013003d4b5c8d7c9aa7dd965e83d981a5a71fd /CONTRIBUTING.md | |
| parent | f6aa8e5d1dfab64848ec2bac2c2b56e10f856b0f (diff) | |
refactor: Refactor code, add new tests
Refactor code so we use a lib, allowing for easier testing. Adds additional tests for layouts.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 124edecd..ed31f95e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,9 +38,11 @@ If you want to help contribute by submitting a PR, by all means, I'm open! In re - I develop primarily using _stable_ Rust. That is, whatever is the most up-to-date stable version you can get via running `rustup update stable`. +- There are some tests, they're mostly for sanity checks. Please run `cargo test` to ensure you didn't break anything important, unless the change will break the test (in which case please amend the tests). + - Note that `cargo test` will fail on anything lower than 1.43.0 due to it using a then-introduced env variable. -- I use both [clippy](https://github.com/rust-lang/rust-clippy) and [rustfmt](https://github.com/rust-lang/rustfmt) in development (with some settings, see [clippy.toml](./clippy.toml) and [rustfmt.toml](rustfmt.toml)). Note clippy must pass to pass CI. +- I use both [clippy](https://github.com/rust-lang/rust-clippy) and [rustfmt](https://github.com/rust-lang/rustfmt) in development (with some settings, see [clippy.toml](./clippy.toml) and [rustfmt.toml](rustfmt.toml)). Note clippy must pass to for PRs to be accepted. - You can check clippy using `cargo +nightly clippy`. |