Skip to content

Commit

Permalink
remove contributing section from README.md, add cargo audit on Contri…
Browse files Browse the repository at this point in the history
…buting.md
  • Loading branch information
voidash committed Aug 27, 2024
1 parent 5704183 commit 4f160df
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 49 deletions.
10 changes: 10 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ you can run the basic CI checks in your local environment:

Learn more [here](https://nexte.st).


- `cargo audit`

This is a tool to check Cargo.lock files for crates containing security vulnerabilities.

```bash
cargo install --locked cargo-audit
```
Learn more [here](https://docs.rs/cargo-audit/latest/cargo_audit/).

- Functional test runner

For dependencies required to run functional tests, see instructions in its [`README.md`](./functional-tests/README.md).
Expand Down
49 changes: 0 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,52 +87,3 @@ Start CL Client/Sequencer
cargo run --bin alpen-express-sequencer -- --config config.toml
```

## Contribution Guidelines

### Development Tools

Please install the following tools in your development environment to make sure that
you can run the basic CI checks in your local environment:

- `taplo`

This is a tool that is used to lint and format `TOML` files. You can install it with:

```bash
brew install taplo
```

You can learn more [here](https://taplo.tamasfe.dev/cli/installation/binary.html).

- `codespell`

This is a tool that is used to check for common misspellings in code. You can install it with:

```bash
pip install codespell # or `pip3 install codespell`
```

You can learn more [here](https://github.com/codespell-project/codespell).

- `nextest`

This is a modern test runner for Rust. You can install it with:

```bash
cargo install --locked nextest
```

Learn more [here](https://nexte.st).

- Functional test runner

For dependencies required to run functional tests, see instructions in its [`README.md`](./functional-tests/README.md).

### Before Creating a PR

Before you create a PR, make sure that all the required CI checks pass locally.
For your convenience, a `Makefile` recipe has been created which you can run via:

```bash
make pr # `make` should already be installed in most systems
```

0 comments on commit 4f160df

Please sign in to comment.