Skip to content

Commit 20ebff4

Browse files
authored
Merge pull request #1089 from q0rban/add-contributing-md
Add a CONTRIBUTING.md file for n00bs like me
2 parents f936910 + 70a11f3 commit 20ebff4

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Contributing to this repository
2+
3+
1. Don't edit the Dockerfiles directly. They are generated using templates.
4+
2. Make any changes to the `*.template` files in the root of the repository.
5+
3. Make sure you've checked the [Requirements](#requirements) below.
6+
4. Run the `./apply-templates.sh` script after making your changes.
7+
5. Once complete, (review and) commit all changes to the templates and Dockerfiles.
8+
9+
## Requirements
10+
11+
You will need the following software packages to run the [`./apply-templates.sh`](/apply-templates.sh) script.
12+
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)