repository-template

Repo Tag Line (1 line)

Repo Brief Description (2 to 5 lines)

Table of Contents

1. Features
2. How to Contribute
3. How to Use
4. Examples
5. Test

Features

Brief Description of the Features offered by this Repository

How to Contribute

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

1. Reporting a bug
2. Discussing the current state of the code
3. Submitting a fix
4. Proposing new features
5. Becoming a maintainer

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

How to Use

Examples

Fourth Example