Skip to content

Add a CONTRIBUTING.md file for n00bs like me #1089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 30, 2020
Merged

Add a CONTRIBUTING.md file for n00bs like me #1089

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2031882
Add a CONTRIBUTING.md file for n00bs like me
Nov 24, 2020
0b6b7e6
Address peer review requests
Nov 24, 2020
70a11f3
Update CONTRIBUTING.md
Nov 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 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, (review and) commit all changes to the templates and Dockerfiles.

## Requirements

You will need the following software packages to run the [`./apply-templates.sh`](/apply-templates.sh) script.

- [GNU awk](https://www.gnu.org/software/gawk/) available as `gawk`.
- [`jq`](https://stedolan.github.io/jq/)
- A recent version of Bash