waalge
/
aiken
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Include info for running CI checks locally (#66)

This commit is contained in:
MitchTurner 2022-10-09 11:33:58 -07:00 committed by GitHub
parent 549a1ae971
commit 756e7c7680
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/rust.yml vendored
View File

@ -17,9 +17,9 @@ jobs:
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- name: Build - name: Build
run: cargo build --verbose run: cargo build --verbose --workspace
- name: Run tests - name: Run tests
run: cargo test --verbose run: cargo test --verbose --workspace
- name: Lint - name: Lint
run: cargo fmt --all -- --check run: cargo fmt --all -- --check
- name: Clippy - name: Clippy

10
CONTRIBUTING.md
View File

@ -31,7 +31,15 @@
Pull requests are welcome, but we do recommend you open an issue to bring any idea to discussion first! Especially if the pull request will end up very large, any significant changes should be discussed up front with the maintainers. This avoids awkward situations where someone puts in a bunch of work to ultimately have the pull request closed due to a potential variety of unforeseen reasons. Pull requests are welcome, but we do recommend you open an issue to bring any idea to discussion first! Especially if the pull request will end up very large, any significant changes should be discussed up front with the maintainers. This avoids awkward situations where someone puts in a bunch of work to ultimately have the pull request closed due to a potential variety of unforeseen reasons.
4. **Donation** CI runs the following commands. To save time, it's good to run these on your local machine before pushing to origin.
```
cargo build --workspace
cargo test --workspace
cargo fmt --all -- --check
cargo clippy --all-targets --all-features -- -D warnings
```
5. **Donation**
Want to give some financial support? Have a look at the [sponsors page](https://github.com/sponsors/rvcas/) for more details. Want to give some financial support? Have a look at the [sponsors page](https://github.com/sponsors/rvcas/) for more details.