Skip to content

Commit b5ab401

Browse files
committed
Add Contributing section to the README.md
I've added some infos for anyone interested in contributing to this project to the README.md.
1 parent c6a6f7c commit b5ab401

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,15 @@ To automate duplicate discovery you may register the trace mode as a Cronjob on
4545
> [!WARNING]
4646
> This mode is not yet implemented.
4747
48+
# Contributing
49+
If you want to contribute to this project, take a look at the TODOs which I've left inside the source files. You can list them all with
50+
```sh
51+
grep -rn --include "*.rs" "TODO:" . | awk '{$1=$1};1'
52+
```
53+
54+
Feel free to make a PR for any of these enhancements. For anything else please open a feature request first, so we can discuss if your idea makes sense in the context of this project.
55+
56+
> [!NOTE] PR standards
57+
> The following standards are a requirement to getting your contributions merged:
58+
> - All submitted code must be properly formatted with the rustfmt defaults.
59+
> - All submitted code must include a reasonable amount of unit tests inside the source file (sometimes less is more but nothing is still nothing).

0 commit comments

Comments
 (0)