docs: add contributing guidelines file

This commit is contained in:
Jake Stanger 2022-08-14 14:34:27 +01:00 committed by GitHub
parent 0b284fd1e8
commit 4b0f0f5f49
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

16
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,16 @@
I welcome contributions of any kind with open arms. That said, please do stick to some basics:
- For code contributions:
- Fix any `cargo clippy` warnings, using at least the default configuration.
- Make sure your code is formatted using `cargo fmt`.
- Keep any documentation up to date.
- I won't enforce it, but preferably stick to [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) messages.
- For PRs:
- Please open an issue or discussion beforehand.
I'll accept most contributions, but it's best to make sure you're not working on something that won't get accepted :)
- For issues:
- Please provide as much information as you can - share your config, any logs, steps to reproduce...