Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add contributing.md #16

Merged
merged 1 commit into from
Oct 19, 2024
+22 −0
Merged

doc: add contributing.md #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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 -->