Skip to content

Commit 0b6b7e6

Browse files
author
James Sansbury
committed
Address peer review requests
1 parent 2031882 commit 0b6b7e6

File tree

1 file changed

+6
-14
lines changed

1 file changed

+6
-14
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,15 @@
1-
## Contributing to this repository
1+
# Contributing to this repository
22

33
1. Don't edit the Dockerfiles directly. They are generated using templates.
44
2. Make any changes to the `*.template` files in the root of the repository.
55
3. Make sure you've checked the [Requirements](#requirements) below.
66
4. Run the `./apply-templates.sh` script after making your changes.
7-
5. Once complete, commit all changes to the templates and Dockerfiles.
7+
5. Once complete, (review and) commit all changes to the templates and Dockerfiles.
88

99
## Requirements
1010

11-
You will need [Gnu Awk](https://www.gnu.org/software/gawk/) to generate the Dockerfiles from the templates.
11+
You will need the following software packages to run the [`./apply-templates.sh`](/apply-templates.sh) script.
1212

13-
To install Gnu Awk on Debian-flavors of Linux:
14-
15-
```
16-
$ apt-get update && apt-get install gawk
17-
```
18-
19-
To install Gnu Awk on Mac/Linux/Windows with [Homebrew](https://brew.sh/):
20-
21-
```
22-
$ brew install gawk
23-
```
13+
- [Gnu Awk](https://www.gnu.org/software/gawk/) available as `gawk`.
14+
- [`jq`](https://stedolan.github.io/jq/)
15+
- A recent version of Bash

0 commit comments

Comments
 (0)