Skip to content

Commit 274d8bc

Browse files
committed
Added contribution guide
1 parent 99b6b0f commit 274d8bc

File tree

1 file changed

+74
-0
lines changed

1 file changed

+74
-0
lines changed

CONTRIBUTING.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# CONTRIBUTING
2+
3+
Apigility and related modules (of which this is one) are open source and licensed
4+
as [BSD-3-Clause](http://opensource.org/licenses/BSD-3-Clause). Contributions
5+
are welcome in the form of issue reports and pull requests.
6+
7+
All pull requests should include unit tests when applicable, and should follow
8+
our coding standards (more on these below); failure to do so may result in
9+
rejection of the pull request. If you need help writing tests, please ask on the
10+
developer mailing list and/or in IRC.
11+
12+
## RESOURCES
13+
14+
If you wish to contribute to Apigility modules, please be sure to
15+
read/subscribe to the following resources:
16+
17+
- [Coding Standards](https://github.com/zendframework/zf2/wiki/Coding-Standards)
18+
- [ZF Git Guide](https://github.com/zendframework/zf2/blob/master/README-GIT.md)
19+
- [Apigility developer mailing list](http://bit.ly/apigility-dev)
20+
- Apigility developer IRC channel: #apigility-dev on Freenode.net
21+
22+
If you are working on new features, refactoring an existing module, or proposing
23+
a new module, please send an email to the developer mailing list.
24+
25+
## REPORTING POTENTIAL SECURITY ISSUES
26+
27+
If you have encountered a potential security vulnerability in any Apigility
28+
module, please report it to us at [[email protected]](mailto:[email protected]).
29+
We will work with you to verify the vulnerability and patch it.
30+
31+
When reporting issues, please provide the following information:
32+
33+
- Module(s) affected
34+
- A description indicating how to reproduce the issue
35+
- A summary of the security vulnerability and impact
36+
37+
We request that you contact us via the email address above and give the project
38+
contributors a chance to resolve the vulnerability and issue a new release prior
39+
to any public exposure; this helps protect Apigility users, and provides them
40+
with a chance to upgrade and/or update in order to protect their applications.
41+
42+
For sensitive email communications, please use
43+
[our PGP key](http://framework.zend.com/zf-security-pgp-key.asc).
44+
45+
## RUNNING TESTS
46+
47+
First, use [Composer](https://getcomposer.org) to install all dependencies:
48+
49+
```console
50+
$ composer install
51+
```
52+
53+
To run tests, use the PHPUnit executable installed by Composer:
54+
55+
```console
56+
$ ./vendor/bin/phpunit
57+
```
58+
59+
## CODING STANDARDS
60+
61+
While Apigility uses Zend Framework 2 coding standards, in practice, we check
62+
standards using [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) (which is
63+
installed via Composer with other dependencies). To check for CS issues:
64+
65+
```console
66+
$ ./vendor/bin/php-cs-fixer fix . --dry-run
67+
```
68+
69+
This will report CS issues. Alternately, you can have the tool fix them for you
70+
by omitting the `--dry-run` switch:
71+
72+
```console
73+
$ ./vendor/bin/php-cs-fixer fix .
74+
```

0 commit comments

Comments
 (0)