Merge pull request #35 from thellimist/patch-2

Add Contribution Document
This commit is contained in:
Junade
2017-11-08 21:28:57 +01:00
committed by GitHub
2 changed files with 21 additions and 1 deletions

17
CONTRIBUTING.md Normal file
View File

@@ -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.

View File

@@ -11,7 +11,6 @@ The recommended way to install this package is via the Packagist Dependency Mana
The Cloudflare API can be found [here](https://api.cloudflare.com/).
Each API call is provided via a similarly named function within various classes in the **Cloudflare\API\Endpoints** namespace:
- [x] [DNS Records](https://www.cloudflare.com/dns/)
- [x] Zones
- [x] User Administration (partial)
@@ -38,6 +37,10 @@ $user = new Cloudflare\API\Endpoints\User($adapter);
echo $user->getUserID();
```
## Contributions
We welcome community contribution to this repository. [CONTRIBUTING.md](CONTRIBUTING.md) will help you start contributing.
## Licensing
Licensed under the 3-clause BSD license. See the [LICENSE](LICENSE) file for details.