Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lampsitter committed Jun 1, 2024
1 parent 9a7f8aa commit 4c45321
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## How to contribute

First of all thank you for considering it. Check out
[ARCHITECTURE.md](ARCHITECTURE.md) for an overview of how the repo is put together.

### Running tests

You won't be able to run the tests without enabling the `macros` feature
as one of the examples depend on it.

`cargo test --feature macros`


### Debugging the proc macros

To see the output of the macros enable the `dump-macro` feature.
For the macro example the output can be viewed like this:

```sh
cargo r --example macro --features dump-macro,macros -- dark | rustfmt --edition=2021 | less
```

0 comments on commit 4c45321

Please sign in to comment.