@@ -5,8 +5,8 @@ If you're here, you would like to contribute to this repository and you're reall
5
5
6
6
## Bug reports
7
7
8
- If you find a bug or a documentation issue, please report it or even better: fix it :). If you
9
- report it, please be as precise as possible. Here is a little list of required information:
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
11
- Precise description of the bug
12
12
- Details of your environment (for example: OS, PHP version, installed extensions)
@@ -15,24 +15,23 @@ report it, please be as precise as possible. Here is a little list of required i
15
15
16
16
## Security issues
17
17
18
- If you discover any security related issues, please contact us at
19
- [ [email protected] ] ( mailto:[email protected] ) instead of submitting an issue on Github.
20
- This allows us to fix the issue and release a security hotfix without publicly disclosing the
21
- vulnerability.
18
+ If you discover any security related issues,
19
+ please contact us at the [ security email address] ( ../../#security ) instead of submitting an issue on Github.
20
+ This allows us to fix the issue and release a security hotfix without publicly disclosing the vulnerability.
22
21
23
22
24
23
## Feature requests
25
24
26
- If you think a feature is missing, please report it or even better: implement it :). If you report
27
- it, describe the more precisely what you would like to see implemented and we will discuss what is
28
- the best approach for it. If you can do some research before submitting it and link the resources
29
- to your description, you're awesome! It will allow us to more easily understood/implement it.
25
+ If you think a feature is missing, please report it or even better: implement it :). If you report it, describe the more
26
+ precisely what you would like to see implemented and we will discuss what is the best approach for it. If you can do
27
+ some research before submitting it and link the resources to your description, you're awesome! It will allow us to more
28
+ easily understood/implement it.
30
29
31
30
32
31
## Sending a Pull Request
33
32
34
- If you're here, you are going to fix a bug or implement a feature and you're the best! To do it,
35
- first fork the repository, clone it and create a new branch with the following commands:
33
+ If you're here, you are going to fix a bug or implement a feature and you're the best!
34
+ To do it, first fork the repository, clone it and create a new branch with the following commands:
36
35
37
36
``` bash
38
37
$ git clone
[email protected] :your-name/repo-name.git
@@ -52,30 +51,28 @@ Write code and tests. When you are ready, run the tests.
52
51
$ composer test
53
52
```
54
53
55
- When you are ready with the code, tested it and documented it, you can commit and push it with the
56
- following commands:
54
+ When you are ready with the code, tested it and documented it, you can commit and push it with the following commands:
57
55
58
56
``` bash
59
57
$ git commit -m " Feature or bug fix description"
60
58
$ git push origin feature-or-bug-fix-description
61
59
```
62
60
63
61
** Note:** Please write your commit messages in the imperative and follow the
64
- [ guidelines] ( http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html ) for clear and
65
- concise messages.
62
+ [ guidelines] ( http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html ) for clear and concise messages.
66
63
67
64
Then [ create a pull request] ( https://help.github.com/articles/creating-a-pull-request/ ) on GitHub.
68
65
69
- Please make sure that each individual commit in your pull request is meaningful. If you had to make
70
- multiple intermediate commits while developing, please squash them before submitting with the
71
- following commands (here, we assume you would like to squash 3 commits in a single one):
66
+ Please make sure that each individual commit in your pull request is meaningful.
67
+ If you had to make multiple intermediate commits while developing,
68
+ please squash them before submitting with the following commands
69
+ (here, we assume you would like to squash 3 commits in a single one):
72
70
73
71
``` bash
74
72
$ git rebase -i HEAD~3
75
73
```
76
74
77
- If your branch conflicts with the master branch, you will need to rebase and repush it with the
78
- following commands:
75
+ If your branch conflicts with the master branch, you will need to rebase and repush it with the following commands:
79
76
80
77
``` bash
81
78
$ git remote add upstream
[email protected] :php-http/repo-name.git
@@ -86,12 +83,18 @@ $ git push -f origin feature-or-bug-fix-description
86
83
87
84
## Coding standard
88
85
89
- This repository follows the [ PSR-2 standard] ( http://www.php-fig.org/psr/psr-2/ ) and so, if you want
90
- to contribute, you must follow these rules.
86
+ This repository follows the [ PSR-2 standard] ( http://www.php-fig.org/psr/psr-2/ ) and so, if you want to contribute,
87
+ you must follow these rules.
91
88
92
89
93
90
## Semver
94
91
95
92
We are trying to follow [ semver] ( http://semver.org/ ) . When you are making BC breaking changes,
96
- please let us know why you think it is important. In this case, your patch can only be included in
97
- the next major version.
93
+ please let us know why you think it is important.
94
+ In this case, your patch can only be included in the next major version.
95
+
96
+
97
+ ## Code of Conduct
98
+
99
+ This project is released with a [ Contributor Code of Conduct] ( CONDUCT.md ) .
100
+ By participating in this project you agree to abide by its terms.
0 commit comments