Skip to content

Commit e451e0d

Browse files
Merge pull request #79 from colbyfayock/patch-1
Updating Contributing
2 parents 3cf628b + ccd32de commit e451e0d

File tree

2 files changed

+50
-32
lines changed

2 files changed

+50
-32
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [GitHub](https://github.com/cloudinary-labs/cloudinary-laravel).
6+
7+
## Issues
8+
9+
### Creating an Issue
10+
If you find a bug, problem, or maybe the documentation just doesn't make sense, please create an Issue to document the concern.
11+
12+
### Description
13+
Please be descriptive in your Issue. The more info you provide, the more likely someone will be able to help.
14+
15+
### Code Examples
16+
If you're experiencing an issue with the code, the most helpful thing you can do is create an example where you can reproduce the problem. This can be an open source Github repo, a private repo you can share with the maintainers, a [CodeSandbox](https://codesandbox.io/), or really anything to show the issue live with code along side of it.
17+
18+
## Pull Requests
19+
20+
The project uses **[PSR-12 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md)**. The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
21+
22+
### Creating a Pull Request
23+
If you're able to fix an active Issue, feel free to create a new Pull Request addressing the problem. There are no gaurantees that the code will be merged in "as is", but chances are, if you're willing to work with the maintainers, everyone will be able to come up with a solution everyone can be happy with.
24+
25+
Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
26+
27+
If you want to do more than one thing, send multiple pull requests.
28+
29+
### Description
30+
Please be descriptive in your Pull Request. Whether big or small, it's important to be able to see the context of a change throughout the history of a project.
31+
32+
### Linking Fixed Issues
33+
If the Pull Request is addressing an Issue, please link that issue by specifying the `Fixes [Issue #]` syntax within the Pull Request.
34+
35+
### Tests
36+
Your patch won't be accepted if it doesn't have tests.
37+
38+
You can run tests with:
39+
``` bash
40+
$ composer test
41+
```
42+
43+
### Documentation
44+
Make sure the `README.md` and any other relevant documentation are kept up-to-date.
45+
46+
### Release Cycle
47+
We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
48+
49+
### Branching
50+
Create a feature branch. Don't ask us to pull from your main branch.

contributing.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)