clearlinux/dockerfiles
2
0
Fork 0
mirror of https://github.com/clearlinux/dockerfiles.git synced 2026-06-30 01:27:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add CONTRIBUTING.md

Browse Source 
Establish a basic set of contributing guidlines to help others get going
quickly.

Signed-off-by: George T Kramer <george.t.kramer@intel.com>
This commit is contained in:
George T Kramer
2019-05-01 13:52:01 -07:00
parent 8f7119f287
commit 0708cfc18f
1 changed files with 43 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+43
View File
@@ -0,0 +1,43 @@
Contributing Guidelines
=======================
Developing Derivative Images
----------------------------
When using Clear Linux as a base for deriving an existing image from Docker
Hub, the goal should be to maintain the same usage of the existing image for
the derivative. This maintains compatibility for users because they will be
able to operate with the derivative in the same manner as the existing image.
This often means:
* Naming the derivative image exactly the same as the existing image.
Documentation references of the name in the derivative README should be
exactly the same as the existing README.
* Modeling the derivative Dockerfile from the existing Dockerfile, removing
pieces that are not relevant for Clear Linux, and supplying defaults required
to operate the microservice on Clear Linux
* Reusing entry point shell scripts from the existing image
* Having a section in the README of the derivative image that references the
README of the existing image
* Having a section in the README of the derivative image that includes an Extra
Build args section mentioning how to use swupd
Criteria for Pull Request Acceptance
------------------------------------
A pull request will be accepted for an image if it satisfies the guidelines
mentioned above.
When opening a pull request, be sure to also modify the .travis.yml to include
the following entry:
```
- DOCKERFILE_DIR=<name of folder containing image>
```
Make sure this entry is in sorted order in the existing list of DOCKERFILE_DIR.
This step allows the build of the image to be tested in Travis CI.
Because of the current usage of Travis CI, any pull request change will trigger
a rebuild of all images. Some of these may fail. The only failure that is
blocking is if the image in question does not build in Travis CI.