2020-11-24 20:18:55 +01:00
|
|
|
# Contributing to this repository
|
2020-11-24 15:46:22 +01:00
|
|
|
|
|
|
|
|
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.
|
2020-11-24 20:18:55 +01:00
|
|
|
5. Once complete, (review and) commit all changes to the templates and Dockerfiles.
|
2020-11-24 15:46:22 +01:00
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
2020-11-24 20:18:55 +01:00
|
|
|
You will need the following software packages to run the [`./apply-templates.sh`](/apply-templates.sh) script.
|
2020-11-24 15:46:22 +01:00
|
|
|
|
2020-11-30 16:28:42 +01:00
|
|
|
- [GNU awk](https://www.gnu.org/software/gawk/) available as `gawk`.
|
2020-11-24 20:18:55 +01:00
|
|
|
- [`jq`](https://stedolan.github.io/jq/)
|
|
|
|
|
- A recent version of Bash
|
