From d8b2093eed485769d458b655867746ebe6a1562e Mon Sep 17 00:00:00 2001 From: Kan Yilmaz Date: Mon, 6 Nov 2017 09:04:19 -0800 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..f8d4e374 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing to Cloudflare PHP API Binding + +👍🎉 First off, thanks for taking the time to contribute! 🎉👍 + +## How To Contribute + +We welcome community contribution to this repository. To help add functionality or address issues, please take the following steps: + +* Fork the repository from the master branch. +* Create a new branch for your features / fixes. +* Make the changes you wish to see. +* Add tests for all changes. +* Run `make fix` command to ensure the code is styled. +* Run `make test` command to ensure the tests pass. +* Create a pull request with details of what changes have been made and explanation of new behaviour. +* Ensure documentation contains the correct information. +* Pull requests will be reviewed and hopefully merged into a release.