-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Contributing | ||
|
||
If you're considering contributing, please open an issue before a PR. A lot of discussion | ||
also happens in the [Neorg Discord](https://discord.gg/T6EgTAX7ht), so you might consider | ||
joining. | ||
|
||
## Tests | ||
|
||
If you change a behavior or fix a bug, please make sure to add a test for it! | ||
|
||
- run the test suite with `cargo test` | ||
|
||
There are snapshot tests and prop tests. If you change the parser behavior or add a new | ||
test case, the snapshots will change and you will see a test failure. You can approve the | ||
new version of the snapshot with: | ||
|
||
- `cargo insta review` | ||
|
||
Prop tests essentially fuzz the parser and make sure that it doesn't panic. Failed test | ||
cases are saved and version controlled to avoid regressions. | ||
|
||
<!-- vim: set tw=85 --> |