update readme, add contributing instructions #6
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| permissions: | |
| contents: read | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| ci: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out Repo | |
| uses: actions/checkout@v4 | |
| - name: Install Rust | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| - name: Build | |
| run: cargo build | |
| - name: Format | |
| run: cargo fmt | |
| - name: Test | |
| run: cargo test | |
| - name: Doc | |
| run: cargo doc | |
| # TODO: create crates.io account and get access token | |
| # publish: | |
| # name: cargo publish |