Add CONTRIBUTING.md

[sunjay]

It's on your TODO list here: https://github.com/toxicFork/react-three-renderer/issues/2#issuecomment-186855445

I was trying to figure out how to contribute. Since I couldn't figure it out, I was left reading the code and searching through issues and pull requests. Most people won't even do that.

Specifically I wanted to build the code and documentation (the wiki). It looks like there's a Gulp task for that, but then there are a bunch of files in the docs/src folder that look autogenerated. It's hard to tell if I can modify those directly or if I should be modifying the generator.

I also didn't know GitHub supported a wiki/ directory. Is that all there is to it or do you magically upload the wiki some other way every time you want to publish the wiki?

Questions to cover in CONTRIBUTING.md

Think of this as a wishlist of all kinds of possible questions the CONTRIBUTING file could answer. Really we just need a bare minimum amount of information to be able to start figuring things out and then submitting them to you for review.

Even just pointing us to things in the code to read or useful PRs would be immensely helpful.

The answers to some of these questions might be related or even the same.

• [ ] How is the code organized?
• [ ] Where do I start to understand how the code works? (Which file? Helpful articles?)
  • This is important because of the highly custom nature of this library, it's completely different from most other react libraries
• [ ] What does a complete PR look like? (Documentation, code, tests, etc.)
• [ ] How do I generate documentation?
• [ ] How do I write tests?
  • [ ] Where do tests go?
  • [ ] Can I see an example?
• [ ] How do I contribute to the wiki?
  • [ ] Do I fork or use the Edit button?
  • [ ] Can I view my changes locally?
  • [ ] How does the wiki work?
  • [ ] Is it automatically generated?
  • [ ] Is the wiki folder uploaded somewhere or does GitHub actually support that?
    • Can't seem to find this on Google

[toxicFork]

Thank you very much for this template! I will create a PR for the doc and fill in the checkboxes :)

[toxicFork]

Adding a milestone to this so I'll have to do it :D

[toxicFork]

looks above oh past me, what have you done...

I'll try a different way, perhaps 30 minutes every day towards this should be better. Apologies.

[sunjay]

@toxicFork no problem! I understand how busy things get. Thanks for taking the time!