danog/php
1
0
Fork 0
mirror of https://github.com/danog/php.git synced 2024-11-29 20:19:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

Address peer review requests

Browse Source
This commit is contained in:
James Sansbury 2020-11-24 14:18:55 -05:00
parent 2031882159
commit 0b6b7e63cf
1 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -1,23 +1,15 @@
## Contributing to this repository
# Contributing to this repository
1. Don't edit the Dockerfiles directly. They are generated using templates.
2. Make any changes to the `*.template` files in the root of the repository.
3. Make sure you've checked the [Requirements](#requirements) below.
4. Run the `./apply-templates.sh` script after making your changes.
5. Once complete, commit all changes to the templates and Dockerfiles.
5. Once complete, (review and) commit all changes to the templates and Dockerfiles.
## Requirements
You will need [Gnu Awk](https://www.gnu.org/software/gawk/) to generate the Dockerfiles from the templates.
You will need the following software packages to run the [`./apply-templates.sh`](/apply-templates.sh) script.
To install Gnu Awk on Debian-flavors of Linux:
```
$ apt-get update && apt-get install gawk
```
To install Gnu Awk on Mac/Linux/Windows with [Homebrew](https://brew.sh/):
```
$ brew install gawk
```
- [Gnu Awk](https://www.gnu.org/software/gawk/) available as `gawk`.
- [`jq`](https://stedolan.github.io/jq/)
- A recent version of Bash