From 9e1280d16ac3a0148c71b09f5c49a229a606c15e Mon Sep 17 00:00:00 2001 From: Ben Lubas Date: Sat, 19 Oct 2024 11:22:28 -0400 Subject: [PATCH] doc: add contributing.md --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1734617 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. + +