|
1 | 1 | # CONTRIBUTING |
2 | 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 | 3 | ## RESOURCES |
13 | 4 |
|
14 | | -If you wish to contribute to Apigility modules, please be sure to |
| 5 | +If you wish to contribute to this project, please be sure to |
15 | 6 | read/subscribe to the following resources: |
16 | 7 |
|
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 |
| 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) |
| 12 | + |
| 13 | +If you are working on new features or refactoring |
| 14 | +[create a proposal](https://github.com/zfcampus/zf-api-problem/issues/new). |
21 | 15 |
|
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. |
| 16 | +## RUNNING TESTS |
24 | 17 |
|
25 | | -## REPORTING POTENTIAL SECURITY ISSUES |
| 18 | +To run tests: |
26 | 19 |
|
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. |
| 20 | +- Clone the repository: |
30 | 21 |
|
31 | | -When reporting issues, please provide the following information: |
| 22 | + ```console |
| 23 | + $ git clone git://github.com/zfcampus/zf-api-problem.git |
| 24 | + $ cd zf-api-problem |
| 25 | + ``` |
32 | 26 |
|
33 | | -- Module(s) affected |
34 | | -- A description indicating how to reproduce the issue |
35 | | -- A summary of the security vulnerability and impact |
| 27 | +- Install dependencies via composer: |
36 | 28 |
|
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. |
| 29 | + ```console |
| 30 | + $ composer install |
| 31 | + ``` |
41 | 32 |
|
42 | | -For sensitive email communications, please use |
43 | | -[our PGP key](http://framework.zend.com/zf-security-pgp-key.asc). |
| 33 | + If you don't have `composer` installed, please download it from https://getcomposer.org/download/ |
44 | 34 |
|
45 | | -## RUNNING TESTS |
| 35 | +- Run the tests using the "test" command shipped in the `composer.json`: |
| 36 | + |
| 37 | + ```console |
| 38 | + $ composer test |
| 39 | + ``` |
46 | 40 |
|
47 | | -First, use [Composer](https://getcomposer.org) to install all dependencies: |
| 41 | +You can turn on conditional tests with the `phpunit.xml` file. |
| 42 | +To do so: |
| 43 | + |
| 44 | + - Copy `phpunit.xml.dist` file to `phpunit.xml` |
| 45 | + - Edit `phpunit.xml` to enable any specific functionality you |
| 46 | + want to test, as well as to provide test values to utilize. |
| 47 | + |
| 48 | +## Running Coding Standards Checks |
| 49 | + |
| 50 | +First, ensure you've installed dependencies via composer, per the previous |
| 51 | +section on running tests. |
| 52 | + |
| 53 | +To run CS checks only: |
48 | 54 |
|
49 | 55 | ```console |
50 | | -$ composer install |
| 56 | +$ composer cs-check |
51 | 57 | ``` |
52 | 58 |
|
53 | | -To run tests, use the PHPUnit executable installed by Composer: |
| 59 | +To attempt to automatically fix common CS issues: |
54 | 60 |
|
55 | 61 | ```console |
56 | | -$ composer test |
| 62 | +$ composer cs-fix |
57 | 63 | ``` |
58 | 64 |
|
59 | | -## CODING STANDARDS |
| 65 | +If the above fixes any CS issues, please re-run the tests to ensure |
| 66 | +they pass, and make sure you add and commit the changes after verification. |
| 67 | + |
| 68 | +## Recommended Workflow for Contributions |
| 69 | + |
| 70 | +Your first step is to establish a public repository from which we can |
| 71 | +pull your work into the master repository. We recommend using |
| 72 | +[GitHub](https://github.com), as that is where the component is already hosted. |
| 73 | + |
| 74 | +1. Setup a [GitHub account](https://github.com/), if you haven't yet |
| 75 | +2. Fork the repository (https://github.com/zfcampus/zf-api-problem) |
| 76 | +3. Clone the canonical repository locally and enter it. |
| 77 | + |
| 78 | + ```console |
| 79 | + $ git clone git://github.com/zfcampus/zf-api-problem.git |
| 80 | + $ cd zf-api-problem |
| 81 | + ``` |
| 82 | + |
| 83 | +4. Add a remote to your fork; substitute your GitHub username in the command |
| 84 | + below. |
| 85 | + |
| 86 | + ```console |
| 87 | + $ git remote add {username} [email protected]:{username}/zf-api-problem.git |
| 88 | + $ git fetch {username} |
| 89 | + ``` |
| 90 | + |
| 91 | +### Keeping Up-to-Date |
| 92 | + |
| 93 | +Periodically, you should update your fork or personal repository to |
| 94 | +match the canonical ZF repository. Assuming you have setup your local repository |
| 95 | +per the instructions above, you can do the following: |
60 | 96 |
|
61 | | -While Apigility uses Zend Framework 2 coding standards, in practice, we check |
62 | | -standards against PSR-1/2. To check for CS issues: |
63 | 97 |
|
64 | 98 | ```console |
65 | | -$ composer cs-check |
| 99 | +$ git checkout master |
| 100 | +$ git fetch origin |
| 101 | +$ git rebase origin/master |
| 102 | +# OPTIONALLY, to keep your remote up-to-date - |
| 103 | +$ git push {username} master:master |
| 104 | +``` |
| 105 | + |
| 106 | +If you're tracking other branches -- for example, the "develop" branch, where |
| 107 | +new feature development occurs -- you'll want to do the same operations for that |
| 108 | +branch; simply substitute "develop" for "master". |
| 109 | + |
| 110 | +### Working on a patch |
| 111 | + |
| 112 | +We recommend you do each new feature or bugfix in a new branch. This simplifies |
| 113 | +the task of code review as well as the task of merging your changes into the |
| 114 | +canonical repository. |
| 115 | + |
| 116 | +A typical workflow will then consist of the following: |
| 117 | + |
| 118 | +1. Create a new local branch based off either your master or develop branch. |
| 119 | +2. Switch to your new local branch. (This step can be combined with the |
| 120 | + previous step with the use of `git checkout -b`.) |
| 121 | +3. Do some work, commit, repeat as necessary. |
| 122 | +4. Push the local branch to your remote repository. |
| 123 | +5. Send a pull request. |
| 124 | + |
| 125 | +The mechanics of this process are actually quite trivial. Below, we will |
| 126 | +create a branch for fixing an issue in the tracker. |
| 127 | + |
| 128 | +```console |
| 129 | +$ git checkout -b hotfix/9295 |
| 130 | +Switched to a new branch 'hotfix/9295' |
66 | 131 | ``` |
67 | 132 |
|
68 | | -This will report CS issues. You can also attempt to fix many reported errors |
69 | | -automatically: |
| 133 | +... do some work ... |
| 134 | + |
70 | 135 |
|
71 | 136 | ```console |
72 | | -$ composer cs-fix |
| 137 | +$ git commit |
73 | 138 | ``` |
74 | 139 |
|
75 | | -If you use `cs-fix` to fix issues, make certain you add and commit any files |
76 | | -changed! |
| 140 | +... write your log message ... |
| 141 | + |
| 142 | + |
| 143 | +```console |
| 144 | +$ git push {username} hotfix/9295:hotfix/9295 |
| 145 | +Counting objects: 38, done. |
| 146 | +Delta compression using up to 2 threads. |
| 147 | +Compression objects: 100% (18/18), done. |
| 148 | +Writing objects: 100% (20/20), 8.19KiB, done. |
| 149 | +Total 20 (delta 12), reused 0 (delta 0) |
| 150 | +To ssh://[email protected]/{username}/zf-api-problem.git |
| 151 | + b5583aa..4f51698 HEAD -> master |
| 152 | +``` |
| 153 | + |
| 154 | +To send a pull request, you have two options. |
| 155 | + |
| 156 | +If using GitHub, you can do the pull request from there. Navigate to |
| 157 | +your repository, select the branch you just created, and then select the |
| 158 | +"Pull Request" button in the upper right. Select the user/organization |
| 159 | +"zfcampus" (or whatever the upstream organization is) as the recipient. |
| 160 | + |
| 161 | +#### What branch to issue the pull request against? |
| 162 | + |
| 163 | +Which branch should you issue a pull request against? |
| 164 | + |
| 165 | +- For fixes against the stable release, issue the pull request against the |
| 166 | + "master" branch. |
| 167 | +- For new features, or fixes that introduce new elements to the public API (such |
| 168 | + as new public methods or properties), issue the pull request against the |
| 169 | + "develop" branch. |
| 170 | + |
| 171 | +### Branch Cleanup |
| 172 | + |
| 173 | +As you might imagine, if you are a frequent contributor, you'll start to |
| 174 | +get a ton of branches both locally and on your remote. |
| 175 | + |
| 176 | +Once you know that your changes have been accepted to the master |
| 177 | +repository, we suggest doing some cleanup of these branches. |
| 178 | + |
| 179 | +- Local branch cleanup |
| 180 | + |
| 181 | + ```console |
| 182 | + $ git branch -d <branchname> |
| 183 | + ``` |
77 | 184 |
|
78 | | -## Conduct |
| 185 | +- Remote branch removal |
79 | 186 |
|
80 | | -Please see our [CONDUCT.md](CONDUCT.md) to understand expected behavior when interacting with others in the project. |
| 187 | + ```console |
| 188 | + $ git push {username} :<branchname> |
| 189 | + ``` |
0 commit comments