22
33## RESOURCES
44
5- If you wish to contribute to Zend Framework , please be sure to
5+ If you wish to contribute to this project , please be sure to
66read/subscribe to the following resources:
77
8- - [ Coding Standards] ( https://github.com/zendframework/zf2/wiki/Coding-Standards )
9- - [ Contributor's Guide] ( http://framework.zend.com/participate/contributor-guide )
10- - ZF Contributor's mailing list:
11- Archives: http://zend-framework-community.634137.n4.nabble.com/ZF-Contributor-f680267.html
12- 13- - ZF Contributor's IRC channel:
14- #zftalk.dev on Freenode.net
8+ - [ Coding Standards] ( https://github.com/zendframework/zend-coding-standard )
9+ - [ Forums] ( https://discourse.zendframework.com/c/contributors )
10+ - [ Chat] ( https://zendframework-slack.herokuapp.com )
11+ - [ Code of Conduct] ( CODE_OF_CONDUCT.md )
1512
16- If you are working on new features or refactoring [ create a proposal] ( https://github.com/zendframework/zend-validator/issues/new ) .
17-
18- ## Reporting Potential Security Issues
19-
20- If you have encountered a potential security vulnerability, please ** DO NOT** report it on the public
21- issue tracker: send it to us at
[ [email protected] ] ( mailto:[email protected] ) instead.
22- We will work with you to verify the vulnerability and patch it as soon as possible.
23-
24- When reporting issues, please provide the following information:
25-
26- - Component(s) affected
27- - A description indicating how to reproduce the issue
28- - A summary of the security vulnerability and impact
29-
30- We request that you contact us via the email address above and give the project
31- contributors a chance to resolve the vulnerability and issue a new release prior
32- to any public exposure; this helps protect users and provides them with a chance
33- to upgrade and/or update in order to protect their applications.
34-
35- For sensitive email communications, please use [ our PGP key] ( http://framework.zend.com/zf-security-pgp-key.asc ) .
13+ If you are working on new features or refactoring
14+ [ create a proposal] ( https://github.com/zendframework/zend-validator/issues/new ) .
3615
3716## RUNNING TESTS
3817
39- > ### Note: testing versions prior to 2.4
40- >
41- > This component originates with Zend Framework 2. During the lifetime of ZF2,
42- > testing infrastructure migrated from PHPUnit 3 to PHPUnit 4. In most cases, no
43- > changes were necessary. However, due to the migration, tests may not run on
44- > versions < 2.4. As such, you may need to change the PHPUnit dependency if
45- > attempting a fix on such a version.
46-
4718To run tests:
4819
4920- Clone the repository:
5021
5122 ``` console
52- $ git clone git@ github.com: zendframework/zend-validator.git
53- $ cd
23+ $ git clone git:// github.com/ zendframework/zend-validator.git
24+ $ cd zend-validator
5425 ```
5526
5627- Install dependencies via composer:
5728
5829 ``` console
59- $ curl -sS https://getcomposer.org/installer | php --
60- $ ./composer.phar install
30+ $ composer install
6131 ```
6232
63- If you don't have ` curl ` installed, you can also download ` composer.phar ` from https://getcomposer.org/
33+ If you don't have ` composer ` installed, please download it from https://getcomposer.org/download /
6434
65- - Run the tests via ` phpunit ` and the provided PHPUnit config, like in this example :
35+ - Run the tests using the "test" command shipped in the ` composer.json ` :
6636
6737 ``` console
68- $ ./vendor/bin/phpunit
38+ $ composer test
6939 ```
7040
71- You can turn on conditional tests with the phpunit.xml file.
41+ You can turn on conditional tests with the ` phpunit.xml ` file.
7242To do so:
7343
7444 - Copy ` phpunit.xml.dist ` file to ` phpunit.xml `
@@ -77,24 +47,22 @@ To do so:
7747
7848## Running Coding Standards Checks
7949
80- This component uses [ phpcs] ( https://github.com/squizlabs/PHP_CodeSniffer ) for coding
81- standards checks, and provides configuration for our selected checks.
82- ` phpcs ` is installed by default via Composer.
50+ First, ensure you've installed dependencies via composer, per the previous
51+ section on running tests.
8352
84- To run checks only:
53+ To run CS checks only:
8554
8655``` console
8756$ composer cs-check
8857```
8958
90- ` phpcs ` also includes a tool for fixing most CS violations, ` phpcbf ` :
91-
59+ To attempt to automatically fix common CS issues:
9260
9361``` console
9462$ composer cs-fix
9563```
9664
97- If you allow ` phpcbf ` to fix CS issues, please re-run the tests to ensure
65+ If the above fixes any CS issues, please re-run the tests to ensure
9866they pass, and make sure you add and commit the changes after verification.
9967
10068## Recommended Workflow for Contributions
@@ -103,12 +71,12 @@ Your first step is to establish a public repository from which we can
10371pull your work into the master repository. We recommend using
10472[ GitHub] ( https://github.com ) , as that is where the component is already hosted.
10573
106- 1 . Setup a [ GitHub account] ( http ://github.com/) , if you haven't yet
107- 2 . Fork the repository (http ://github.com/zendframework/zend-validator
74+ 1 . Setup a [ GitHub account] ( https ://github.com/) , if you haven't yet
75+ 2 . Fork the repository (https ://github.com/zendframework/zend-validator
108763 . Clone the canonical repository locally and enter it.
10977
11078 ``` console
111- $ git clone git://github.com: zendframework/zend-validator.git
79+ $ git clone git://github.com/ zendframework/zend-validator.git
11280 $ cd zend-validator
11381 ```
11482
@@ -188,15 +156,7 @@ To send a pull request, you have two options.
188156If using GitHub, you can do the pull request from there. Navigate to
189157your repository, select the branch you just created, and then select the
190158"Pull Request" button in the upper right. Select the user/organization
191- "zendframework" as the recipient.
192-
193- If using your own repository - or even if using GitHub - you can use `git
194- format-patch` to create a patchset for us to apply; in fact, this is
195- ** recommended** for security-related patches. If you use ` format-patch ` , please
196- send the patches as attachments to:
197-
198- - [email protected] for patches without security implications
199- - [email protected] for security patches
159+ "zendframework" (or whatever the upstream organization is) as the recipient.
200160
201161#### What branch to issue the pull request against?
202162
@@ -227,8 +187,3 @@ repository, we suggest doing some cleanup of these branches.
227187 ``` console
228188 $ git push {username} :<branchname>
229189 ```
230-
231-
232- ## Conduct
233-
234- Please see our [ CONDUCT.md] ( CONDUCT.md ) to understand expected behavior when interacting with others in the project.
0 commit comments