Improve documentation to provide more instructions, tips, trick to make contributions easier.
As a new contributor who submitted contributions lately, I made many rookie mistakes that could have been avoided if I had known ahead of time, a few tips and tricks.
There are also expectations from maintainers on documenting changes and PR (ie provide details on what is being change). These expectations do not seem to be documented either.
There is no mention of running static analysis to improve quality
I propose to
- Review and improve CONTRIBUTING.MD
- Review and improve if needed, the issue and PR templates
You can assign the issue to me
Improve documentation to provide more instructions, tips, trick to make contributions easier.
As a new contributor who submitted contributions lately, I made many rookie mistakes that could have been avoided if I had known ahead of time, a few tips and tricks.
There are also expectations from maintainers on documenting changes and PR (ie provide details on what is being change). These expectations do not seem to be documented either.
There is no mention of running static analysis to improve quality
I propose to
You can assign the issue to me