CONTRIBUTING.md

For contributors

1. Please have fun, nobody is paid for developing Panopticon.
2. Everything is up to debate, none of the following guidelines are set in stone.
3. If you want to help, check out the easy issues.
4. If you want a feature, open an issue before you're dumping your 5k line patch.
5. Format w/ rustfmt before submitting.
6. Please add tests, at least one positive and one negative test. Make sure the coverage doesn't decrease.
7. Consider splitting your change into multiple smaller PRs.
8. All CI jobs must pass. You have an infinite amount of tries.

For maintainers & reviewers

1. Assume good faith.
2. Please have fun, nobody is paid for developing Panopticon.
3. Everything is up to debate, none of the following guidelines are set in stone.
4. Check whether contributed code:
   1. scales reasonably well,
   2. has no (obvious) security problems,
   3. isn't reimplementing features that already exist in Panopticon,
   4. is in the right place,
   5. comes w/ unit tests that demonstrate the code works and make sure it can be changed later,
   6. includes legible documentation.
5. No bikeshedding about naming, brace placement, argument order, "taste" or "style".
6. If in doubt, merge.
7. Please thank the contributor. It costs nothing. Also, see 2.