Skip to content

Commit c6aca5d

Browse files
authored
Create CONTRIBUTING.md (#17)
1 parent 91ddd83 commit c6aca5d

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing guide
2+
3+
The contribution is accepted via Pull Requests
4+
5+
## Pull Requests
6+
7+
- **Follow the conventions used in the project.** - Fix the code style with `$ php-cs-fixer fix`.
8+
9+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
10+
11+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
12+
13+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/).
14+
Randomly breaking public APIs is not an option.
15+
16+
- **Create feature branches** - Don't ask us to pull from your master branch, create branch, e.g. `feature-name` or `bugfix-title`.
17+
18+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. Use appropriate labels.
19+
20+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful.
21+
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.
22+
Please read [How to write a good Git commit messages](https://chris.beams.io/posts/git-commit/)
23+
24+
25+
## Running Tests
26+
27+
~~~bash
28+
$ phpunit
29+
~~~
30+
31+
32+
## Project's standards
33+
34+
* [PSR-1: Basic Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
35+
* [PSR-2: Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
36+
* [PSR-4: Autoloading Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md)
37+
* [PSR-5: PHPDoc (draft)](https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md)
38+
* Keep the order of class elements: static properties, instance properties, constructor (or setUp for PHPUnit), destructor (or tearDown for PHPUnit), static methods, instance methods, magic static methods, magic instance methods.
39+
40+
41+
**Enjoy coding**!

0 commit comments

Comments
 (0)