From 5b7a08f490aa070edd074b47cec0896bd82ea0fe Mon Sep 17 00:00:00 2001 From: Luke Oliff Date: Wed, 12 Sep 2018 10:28:13 +0100 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7b3c4b4..3137609 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,37 @@ -Repo for first timers to PR onto during Hacktoberfest 2018, with their name, etc. +This repository is for anyone to create pull requests during Hacktoberfest 2018, with their name, code samples, etc. Any PRs outside of hacktoberfest will still be considered, but may not count towards your hacktofebest contributions. -## Contributors +## Contributing -Please read [CONTRIBUTING](CONTRIBUTING.md) before submitting your PR. +Please read our [contributing](CONTRIBUTING.md) guidelines before making your pull request. + +### 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. +* 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 + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. ### Example Profile - I'm an example that you can copy, if you want :)