Write contributing guidlines (CONTRIBUTING.md)

GentenStudios / QuartzEngine

Nolonger used, see Phoenix repo

BSD 3-Clause "New" or "Revised" License

34 stars 10 forks source link

Write contributing guidlines (CONTRIBUTING.md) #143

Open DontBelieveMe opened 5 years ago

DontBelieveMe commented 5 years ago

Write basic contribution guidelines (CONTRIBUTING.md) include

Getting started
- Getting the source
- Build
- Easy first tasks
Submitting bugs
Git branching system
Submitting PR's
Coding style
- clang-format
- Mention how clang-format-diff should probably be run on a patch before a PR is submitted.
- other tools etc.. and probably other stuff as well, add more as needed & discuss before adding anything.

vyomfadia commented 5 years ago

We've got that in the Genten repo's wiki IIRC, so we could just link to that.

We need to do the Getting Started bit, and probably the bugs part too, but the branching + PRs + Coding style we can put in our global Genten wiki and just link to that.