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
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
6
+
7
+
Examples of unacceptable behavior by participants include:
8
+
9
+
* The use of sexualized language or imagery
10
+
* Personal attacks
11
+
* Trolling or insulting/derogatory comments
12
+
* Public or private harassment
13
+
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
14
+
* Other unethical or unprofessional conduct.
15
+
16
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
17
+
18
+
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
19
+
20
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
21
+
22
+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26-6
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,9 @@ please be as precise as possible. Here is a little list of required information:
15
15
16
16
## Security issues
17
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. This allows us to fix the issue and release a security hotfix without publicly disclosing the 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.
19
21
20
22
21
23
## Feature requests
@@ -28,7 +30,8 @@ easily understood/implement it.
28
30
29
31
## Sending a Pull Request
30
32
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:
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:
@@ -41,7 +44,12 @@ Then install the dependencies through [Composer](https://getcomposer.org/):
41
44
$ composer install
42
45
```
43
46
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
+
Write code and tests. When you are ready, run the tests.
48
+
(This is usually [PHPUnit](http://phpunit.de/) or [PHPSpec](http://phpspec.net/))
49
+
50
+
```bash
51
+
$ composer test
52
+
```
45
53
46
54
When you are ready with the code, tested it and documented it, you can commit and push it with the following commands:
**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.
61
+
**Note:** Please write your commit messages in the imperative and follow the
62
+
[guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for clear and concise messages.
54
63
55
64
Then [create a pull request](https://help.github.com/articles/creating-a-pull-request/) on GitHub.
56
65
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):
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):
58
70
59
71
```bash
60
72
$ git rebase -i HEAD~3
@@ -77,4 +89,12 @@ you must follow these rules.
77
89
78
90
## Semver
79
91
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.
92
+
We are trying to follow [semver](http://semver.org/). When you are making BC breaking changes,
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