Skip to content

Commit 4c45321

Browse files
committed
Add CONTRIBUTING.md
1 parent 9a7f8aa commit 4c45321

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## How to contribute
2+
3+
First of all thank you for considering it. Check out
4+
[ARCHITECTURE.md](ARCHITECTURE.md) for an overview of how the repo is put together.
5+
6+
### Running tests
7+
8+
You won't be able to run the tests without enabling the `macros` feature
9+
as one of the examples depend on it.
10+
11+
`cargo test --feature macros`
12+
13+
14+
### Debugging the proc macros
15+
16+
To see the output of the macros enable the `dump-macro` feature.
17+
For the macro example the output can be viewed like this:
18+
19+
```sh
20+
cargo r --example macro --features dump-macro,macros -- dark | rustfmt --edition=2021 | less
21+
```

0 commit comments

Comments
 (0)