Skip to content

Commit 94d9e33

Browse files
authored
doc: add contributing.md (#16)
1 parent 07a2294 commit 94d9e33

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing
2+
3+
If you're considering contributing, please open an issue before a PR. A lot of discussion
4+
also happens in the [Neorg Discord](https://discord.gg/T6EgTAX7ht), so you might consider
5+
joining.
6+
7+
## Tests
8+
9+
If you change a behavior or fix a bug, please make sure to add a test for it!
10+
11+
- run the test suite with `cargo test`
12+
13+
There are snapshot tests and prop tests. If you change the parser behavior or add a new
14+
test case, the snapshots will change and you will see a test failure. You can approve the
15+
new version of the snapshot with:
16+
17+
- `cargo insta review`
18+
19+
Prop tests essentially fuzz the parser and make sure that it doesn't panic. Failed test
20+
cases are saved and version controlled to avoid regressions.
21+
22+
<!-- vim: set tw=85 -->

0 commit comments

Comments
 (0)