From 0e02b810660ce8e574d36f6cbc079aadf13a48c1 Mon Sep 17 00:00:00 2001 From: Luke Oliff Date: Wed, 12 Sep 2018 10:25:15 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c47bd67..dfec26a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,29 @@ # Contributing +## How to Contribute + +This repository is built for the purpose of encouraging your contributions, big or small. **All** changes are considered, as long as they do not complicate the process for others. + +That said, suggest ways to contribute include: + +### Your name on the readme.md + * Fork the project. -* Make your addition or fix. -* Send a pull request. Bonus points for topic branches. +* Add your name to the readme.md using the example provided. +* Commit and send a pull request. Bonus points for correctly named branches. + +### A code sample + +* Fork the project. +* Create a code sample under `/code` named .. I.e. `lukeoliff.js`, `lukeoliff.php` +* Create a working hello world example inside your file. +* Commit and send a pull request. Bonus points for correctly named branches. + +### Anything else + +* Fork the project. +* Make your change. +* Commit and send a pull request. Bonus points for correctly named branches. ## Code of Conduct