You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+36-30Lines changed: 36 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -3,63 +3,58 @@
3
3
If you're here, you would like to contribute to this repository and you're really welcome!
4
4
5
5
6
-
## Coding standard
6
+
## Bug reports
7
7
8
-
This repository follows the [PSR-2 standard](http://www.php-fig.org/psr/psr-2/) and so, if you want to contribute,
9
-
you must follow these rules.
8
+
If you find a bug or a documentation issue, please report it or even better: fix it :). If you report it,
9
+
please be as precise as possible. Here is a little list of required information:
10
10
11
+
- Precise description of the bug
12
+
- Details of your environment (for example: OS, PHP version, installed extensions)
13
+
- Backtrace which might help identifing the bug
11
14
12
-
## Feature request
13
15
14
-
If you think a feature is missing, please report it or even better implement it :). If you report it, describe the more
15
-
precisely what you would like to see implemented and we will discuss what is the best approach for it. If you can do
16
-
some search before submitting it and link the resources to your description, you're awesome! It will allow me to more
17
-
easily understood/implement it.
16
+
## Security issues
18
17
18
+
If you discover any security related issues, please contact us at [[email protected]](mailto:[email protected]) instead of submitting an issue on Github.
19
19
20
-
## Bug report
21
20
22
-
If you think you have detected a bug or a doc issue, please report it or even better fix it :). If you report it,
23
-
please be the more precise possible. Here a little list of required informations:
21
+
## Feature requests
24
22
25
-
* Precise description of the bug.
23
+
If you think a feature is missing, please report it or even better: implement it :). If you report it, describe the more
24
+
precisely what you would like to see implemented and we will discuss what is the best approach for it. If you can do
25
+
some search before submitting it and link the resources to your description, you're awesome! It will allow us to more
26
+
easily understood/implement it.
26
27
27
28
28
-
## Bug fix
29
+
## Sending a Pull Request
29
30
30
-
If you're here, you are going to fix a bug and you're the best! To do it, first fork the repository, clone it and
31
-
create a new branch with the following commands:
31
+
If you're here, you are going to fix a bug or implement a feature and you're the best! To do it, first fork the repository, clone it and create a new branch with the following commands:
Then, install the dependencies through [Composer](https://getcomposer.org/):
38
+
Then install the dependencies through [Composer](https://getcomposer.org/):
39
39
40
40
```bash
41
41
$ composer install
42
42
```
43
43
44
-
When you're on the new branch with the dependencies, code as much as you want and when the fix is ready, don't commit
45
-
it immediately. Before, you will need to add tests and update the doc. For the tests, everything is tested with
46
-
[PHPUnit](http://phpunit.de/) and the doc is in the markdown format under the `doc` directory.
44
+
Write code and tests. When you are ready, find the testing command in the [README](README.md) and execute it. (This is usually [PHPUnit](http://phpunit.de/) or [PHPSpec](http://phpspec.net/))
47
45
48
-
To run the tests, use the following command:
46
+
When you are ready with the code, tested it and documented it, you can commit and push it with the following commands:
49
47
50
48
```bash
51
-
$ vendor/bin/phpunit
49
+
$ git commit -m "Feature or bug fix description"
50
+
$ git push origin feature-or-bug-fix-description
52
51
```
53
52
54
-
When you have fixed the bug, tested it and documented it, you can commit and push it with the following commands:
53
+
**Note:** Please write your commit messages in the imperative and follow the [guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for clear and concise messages.
55
54
56
-
```bash
57
-
$ git commit -m "Bug fix description"
58
-
$ git push origin bug-fix-description
59
-
```
55
+
Then [create a pull request](https://help.github.com/articles/creating-a-pull-request/) on GitHub.
60
56
61
-
If you have reworked you patch, please squash all your commits in a single one with the following commands (here, we
62
-
will assume you would like to squash 3 commits in a single one):
57
+
Please make sure that each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting with the following commands (here, we assume you would like to squash 3 commits in a single one):
63
58
64
59
```bash
65
60
$ git rebase -i HEAD~3
@@ -70,5 +65,16 @@ If your branch conflicts with the master branch, you will need to rebase and rep
This repository follows the [PSR-2 standard](http://www.php-fig.org/psr/psr-2/) and so, if you want to contribute,
75
+
you must follow these rules.
76
+
77
+
78
+
## Semver
79
+
80
+
We are trying to follow [semver](http://semver.org/). When you are making BC breaking changes, please let us know why you think it is important. In this case, your patch can only be included in the next major version.
0 commit comments