Skip to content

Commit 65e4f29

Browse files
authored
Merge pull request #35 from thellimist/patch-2
Add Contribution Document
2 parents 3453e44 + 8ee1bbc commit 65e4f29

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing to Cloudflare PHP API Binding
2+
3+
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
4+
5+
## How To Contribute
6+
7+
We welcome community contribution to this repository. To help add functionality or address issues, please take the following steps:
8+
9+
* Fork the repository from the master branch.
10+
* Create a new branch for your features / fixes.
11+
* Make the changes you wish to see.
12+
* Add tests for all changes.
13+
* Run `make fix` command to ensure the code is styled.
14+
* Run `make test` command to ensure the tests pass.
15+
* Create a pull request with details of what changes have been made and explanation of new behaviour.
16+
* Ensure documentation contains the correct information.
17+
* Pull requests will be reviewed and hopefully merged into a release.

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ The recommended way to install this package is via the Packagist Dependency Mana
1111
The Cloudflare API can be found [here](https://api.cloudflare.com/).
1212
Each API call is provided via a similarly named function within various classes in the **Cloudflare\API\Endpoints** namespace:
1313

14-
1514
- [x] [DNS Records](https://www.cloudflare.com/dns/)
1615
- [x] Zones
1716
- [x] User Administration (partial)
@@ -38,6 +37,10 @@ $user = new Cloudflare\API\Endpoints\User($adapter);
3837
echo $user->getUserID();
3938
```
4039

40+
## Contributions
41+
42+
We welcome community contribution to this repository. [CONTRIBUTING.md](CONTRIBUTING.md) will help you start contributing.
43+
4144
## Licensing
4245

4346
Licensed under the 3-clause BSD license. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)