Contributing - Githubissues

allan2 / dotenvy

A well-maintained fork of the dotenv crate

MIT License

688 stars 43 forks source link

Contributing #56

Closed sonro closed 1 year ago

sonro commented 1 year ago

I feel we should create better contributing guidelines for this project. I know its only a small crate, but it would be best if issues were opened before PRs and the current info in the README just says "Contributions and PRs are very welcome!"

I personally think a CONTRIBUTING.md file is the way to go, with info on how to pass CI, (testing, clippy, formatting etc). Also updating the README to ask contributors to open an issue first and read the file would be a good idea.

allan2 commented 1 year ago

Sounds good!

Some thoughts:

welcoming tone (Axum does this well, as does this user)
a suggestion to open issues to solicit feedback before making large changes (paraphrased from here)
mention CI (probably not necessary to write instructions but it would be good to mention. at least in passing)
update CHANGELOG
encourage asking for help (either in issues and/or discussions?). This could be caused by the docs missing something