Update CONTRIBUTING.md

This commit is contained in:
Luke Oliff 2018-09-12 10:25:15 +01:00 committed by GitHub
parent 97ba9a4e1b
commit 0e02b81066
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,8 +1,29 @@
# Contributing # 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. * Fork the project.
* Make your addition or fix. * Add your name to the readme.md using the example provided.
* Send a pull request. Bonus points for topic branches. * 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 <yourname>.<language-file-extension>. 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 ## Code of Conduct