mirror of
https://github.com/standardebooks/web.git
synced 2025-07-19 04:44:48 -04:00
Add Safe PHP functions
This commit is contained in:
parent
04a956886a
commit
58cc098058
260 changed files with 49458 additions and 45 deletions
38
vendor/thecodingmachine/safe/CONTRIBUTING.md
vendored
Normal file
38
vendor/thecodingmachine/safe/CONTRIBUTING.md
vendored
Normal file
|
@ -0,0 +1,38 @@
|
|||
# Contributing
|
||||
|
||||
Safe-PHP code is generated automatically from the PHP doc.
|
||||
|
||||
## How to install Safe-PHP development environment
|
||||
|
||||
The first step is to download the PHP documentation project locally.
|
||||
You will need Subversion (svn) installed on your computer.
|
||||
|
||||
```bash
|
||||
$ cd generator/doc
|
||||
$ svn co https://svn.php.net/repository/phpdoc/modules/doc-en doc-en
|
||||
$ cd ../..
|
||||
```
|
||||
|
||||
At any point, if you want to update the documentation to the latest version, you can use:
|
||||
|
||||
```bash
|
||||
$ cd generator/doc/doc-en
|
||||
$ svn update
|
||||
```
|
||||
|
||||
### Generating the functions
|
||||
|
||||
Generating the functions can be done with a simple command.
|
||||
|
||||
```bash
|
||||
$ cd generator
|
||||
$ php ./safe.php generate
|
||||
```
|
||||
|
||||
### Submitting a PR
|
||||
|
||||
The continuous integration hooks will regenerate all the functions and check that the result is exactly what has been
|
||||
committed. Therefore, before submitting a PR, please:
|
||||
|
||||
- Perform a "svn update"
|
||||
- Regenerate the files using `php ./safe.php generate`
|
Loading…
Add table
Add a link
Reference in a new issue