danog/php
1
0
Fork 0
mirror of https://github.com/danog/php.git synced 2025-01-22 04:51:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add a CONTRIBUTING.md file for n00bs like me

Browse Source
This commit is contained in:
James Sansbury 2020-11-24 09:46:22 -05:00
parent 0180511974
commit 2031882159
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,23 @@
## 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.
## Requirements
You will need [Gnu Awk](https://www.gnu.org/software/gawk/) to generate the Dockerfiles from the templates.
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
```