Skip to content

Commit

Permalink
doc: add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
benlubas committed Oct 19, 2024
1 parent a15600c commit 9e1280d
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
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 -->

0 comments on commit 9e1280d

Please sign in to comment.