ta2edchimp / discussion-contribution-guidelines Goto Github PK

In kentcdodds/eslint-find-new-rules and ta2edchimp/opt-cli pretty much the same CONTRIBUTING.md is used.
I for myself thought of this as a superior example of a comprehensive step by step guide on how to participate in development, but it seems to discourage even experienced contributors to oss by the sheer amount of options to test --watch, validate, following conventional commit messages, opting out in such a short, condensed (but by that overwhelming) list. And, making things even worse, the next project one might be interested in participating, could have a contribution guide that might be of the same content, but using different terminology, different formatting, etc.

As a result of a discussion, it would be awesome, if we could come up with a concrete template that:

• applies to a wide range of projects (omitting parts not fitting),
• ensures to comply to high coding standards (considering tests, validation, conventional commit messages, etc.) for experienced contributors,
• while providing a detailed step by step guide for beginners as well as "one-timers"* on how they could contribute.

*) "One-timers" example: I mean, it is frustrating to set up a project, dive into a complicated build procedure, thinking forever about conventional commit messages, just to fix a typo in a README or change an or to an and in an if condition.

Ideas on what such a template could include:

• How to setup a working copy of a project to make changes to
  • GitHub itself has a nice tutorial on how to do this for complete beginners to git,
  • kentcdodds has made an awesome, comprehensive video tutorial about how to contribute on GitHub.
• How to comply to a project's contribution conventions, including (but not limited to) stuff like
  • all-contributors,
  • conventional commit messages and their validation,
  • running "code validation" (linting, testing, etc.),
  • requiring to squash commits,
  • as well as how to opt out of them when running into issues.