Create CONTRIBUTING.md file about osctrl HOT 4 CLOSED

Hey, I'd like to pick this up if possible though I'm not quite sure what is needed just yet.

from osctrl.

Awesome! We can start gathering few examples of other CONTRIBUTING.md files, and turn this into the file: https://www.osctrl.net/contributing/

from osctrl.

Cool, Thanks!

from osctrl.

I'm not sure what you mean by "and turn this into the file". I've transplanted what that page has to a CONTRIBUTING.md file within the repo for an initial file. Is this what you meant? You can view it here.

Some other things I could think of that should be in there or would be useful.

Anything about code quality and/or standards?
Unit tests? Integration tests?
How to build?
How to run tests?
Is there a license agreement?
What's the bare minimum needed to work on this project? Compiler, versions, libraries, hardware requirements?
Are there any guidelines are PRs? Pass CI/CD?

I know some of these are answered by documentation which I'm still going through. But figured I'd put my thoughts here while I finish up the documentation.

from osctrl.