diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..52ab065b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +So you're interested in helping out? That's great! + +First of all, please have a look at our [LLM use policy](https://silverbullet.md/LLM%20Use) (TL;DR: no). All good? Let's proceed. + +## Issuing PRs +Before issuing a PR, please run a few commands: + +```bash +# Run all tests +make test +# Reformat all code +make fmt +``` + +This ensures that the basics work.