Skip to content

Commit d46239d

Browse files
committed
add contributing file
1 parent 1c349c6 commit d46239d

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via pull requests on [Github].
6+
Please make all pull requests to the `develop` branch, not the `master` branch.
7+
8+
## Pull Requests
9+
10+
- **Create an issue** - Explain as detailed as possible the issue you encountered so we can understand the context of your pull request
11+
- **[Symfony Coding Standard]** - The easiest way to apply the conventions is to run `composer lint`
12+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
14+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
15+
- **Create feature branches** - Don't ask us to pull from your master branch.
16+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
17+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
18+
19+
## Running Tests
20+
21+
``` bash
22+
$ composer test
23+
```
24+
25+
**Happy coding**!
26+
27+
[Github]: https://github.com/wsdltophp/packagebase
28+
[Symfony Coding Standard]: http://symfony.com/doc/current/contributing/code/standards.html

0 commit comments

Comments
 (0)