Skip to content

Commit

Permalink
fix: remove extra newlines in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gibbz00 committed Oct 25, 2024
1 parent 1de0644 commit 881e386
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions CONTRIBUTING_FINAL.md.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ There are some things that should be kept in mind when contributing to this proj
* [`taplo`](https://github.com/tamasfe/taplo)
* [`rust-analyzer`](https://github.com/rust-lang/rust-analyzer)
{% if include_precommit -%}

### Using pre-commit hooks

This project makes use of [`pre-commit`](https://pre-commit.com/) hooks. A `pre-commit install` is recommended once the repository has been cloned, unless it has been [auto-enabled](https://pre-commit.com/#automatically-enabling-pre-commit-on-repositories).
Expand All @@ -25,25 +26,21 @@ Pretty standard procedure apart from noting that some tests may be behind featur
```sh
cargo test --all-features
```

{% if include_mdbook -%}
Book testing may be done by:

```sh
mdbook test
```
{%- endif %}

### Generating and opening documentation

```sh
cargo doc --no-deps --all-features --open
```

{% if include_mdbook -%}
Book documentation may be generated by installing [`mdbook`](https://rust-lang.github.io/mdBook/guide/installation.html) before running `mdbook serve --open`.
{%- endif %}

## Release (for maintainers)

1. Make sure CI is not failing.
Expand Down

0 comments on commit 881e386

Please sign in to comment.