|
1 | 1 | # Contributing guidelines for PHP: Nelson Martell Library
|
2 | 2 |
|
3 | 3 | ## Global requirements
|
4 |
| -- Git |
5 |
| -- PHP 5.6+ |
6 |
| -- [Composer](https://getcomposer.org/) |
7 |
| -- Node.js |
8 |
| -- [Yarn](https://yarnpkg.com) |
9 |
| -- [phpDocumentor](https://www.phpdoc.org/) |
| 4 | +- `git` - [Git](https://git-scm.com/) |
| 5 | +- `php` - PHP 5.6+ |
| 6 | +- `composer` - [Composer](https://getcomposer.org/) |
| 7 | +- `yarn` - [Yarn](https://yarnpkg.com) (and `node` v8+) |
| 8 | +- `phpdoc` - [phpDocumentor](https://www.phpdoc.org/) |
10 | 9 |
|
11 | 10 | ### Initialization
|
12 | 11 |
|
|
41 | 40 |
|
42 | 41 | - **`composer check-all`**: Runs coding standard analisis (PHP: Code Sniffer) + tests (PHPUnit).
|
43 | 42 |
|
44 |
| -- **`composer build`**: Run this sub-scripts: |
45 |
| - 1. **`composer build-code-coverage`**: Runs tests and build code coverage reports (XML and HTML formats) in `output/code-coverage/` directory. |
46 |
| - - For XML format only (`output/code-coverage/clover.xml`): **`composer build-code-coverage-clover`** or **`composer build-code-coverage-xml`** (alias). |
47 |
| - - For HTML format only: **`composer build-code-coverage-html`**. |
48 |
| - |
49 |
| -- **`composer build-api`**: Generates API documentation in `output/api/` directory using [ApiGen](https://github.com/ApiGen/ApiGen). |
| 43 | +- **`composer build-code-coverage`**: Runs tests and build code coverage reports (XML and HTML formats) in `output/code-coverage/` directory. |
| 44 | + - **`composer build-code-coverage-clover`**: For XML format only (`output/code-coverage/clover.xml`) |
| 45 | + - **`composer build-code-coverage-xml`**: Alias for `composer build-code-coverage-clover`. |
| 46 | + - **`composer build-code-coverage-html`**: For HTML format only. |
50 | 47 |
|
51 | 48 |
|
52 | 49 | - **`phpdoc`**: Generates the API documentation files (`*.md`) compatible with VuePress.
|
53 | 50 |
|
54 | 51 | - **`yarn docs:dev`**: Generates VuePress documentation in development mode to check changes while writing.
|
55 | 52 |
|
56 | 53 | - **`yarn docs:build`**: Build the VuePress documentation to be published.
|
57 |
| - |
58 |
| - |
59 |
| - |
60 |
| - |
61 |
| -### Deployment scripts |
62 |
| -[DEPRECATED] |
63 |
| -- `.travis/deploy-documentation`: Generates documentation and publish it in `gh-pages` brach. **Note:** _This script is used by [Travis CI](travis-ci.org) to publish documentation and **should not be run in local development**_. |
0 commit comments