REQUEST: Add CONTRIBUTING.md and STYLEGUIDE.md to this repo

[RobSeder]

Is your feature request related to a problem? Please describe.

You just made a video about contributing to open source, but not liking the quality or style of pull requests.

Describe the solution you'd like

The GitHub answer to that is to create a CONTRIBUTING.md file that describes how to properly and ideally contribute to your repo. This might include things like "don't make huge changes", "do make a small, specific changes", "Include a cover lever with your PR to describe what you've done", etc.

Also, consider creating a STYLEGUIDE.md file, also in the root of the repo. This will include things like: tabs vs spaces, PascalCase vs camelCase, file naming standards, comment style (e.g. "#" vs "/* */", etc). There is not a formal spec for what is in a repo style guide, so just include the formatting and styling things that you care about.

• For CONTRIBUTING.md see:

  • Setting Guidelines for Repository Contributors and example

• For STYLEGUIDE.md see:

  • Writing on GitHub
  • GitHub Docs Style Guide
  • Example: Google Deepmind
  • Example: Twitter Archive

Describe alternatives you've considered

None. This is for everyone's benefit and it is the industry standard.

Additional context

Adding this communication is a way that you can clearly convey how you would like to see pull requests. Or, if you get a low quality pull request, then you can point the contributor to these files for correction.

[ChrisTitusTech]

Thanks for pointing this out Rob, I'll add it to the project!

[github-actions]

This issue was marked as stale because it has been inactive for 7 days