From d3a4b5e12b70e42ee55eac75732155e6804de529 Mon Sep 17 00:00:00 2001 From: wglambert Date: Sat, 30 Oct 2021 16:30:55 -0700 Subject: [PATCH] Add "Inclusion Criteria" --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5dad9bf..f9a50a0 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ As stewards of the official images and maintainers of many images ourselves, we ### What do you mean by "Official"? -The name of this program was chosen in an attempt to reflect our upstream-first focus (although in hindsight, it's clear that it was a choice with some amount of confusion potential for which we're sorry). +The name of this program was chosen in an attempt to reflect our upstream-first focus (although in hindsight, it's clear that it was a choice with some amount of confusion potential for which we're sorry). See [the readme of the `github.com/docker-library/official-images` repository](https://github.com/docker-library/official-images#what-are-official-images) for a more verbose overview of the program. @@ -80,6 +80,14 @@ The actual infrastructure is a combination of machines provided by our generous For a more complete view of the full image change/publishing process, see ["An image's source changed in Git, now what?"](#an-images-source-changed-in-git-now-what) above. +### Inclusion Criteria + +See ["What are 'Official Images'?" in the main project repository](https://github.com/docker-library/official-images#what-are-official-images) for a high-level overview of the focus and goals of the project in general. + +Per [the "New Image Checklist"](https://github.com/docker-library/official-images/blob/master/NEW-IMAGE-CHECKLIST.md) (which is used to roughly track status during "New Image" reviews), one of the primary determinations we try to make is whether the image being proposed is "generally useful" and whether the software itself is "reasonably popular" and/or "solves a particular use case well" (to help focus our review bandwidth on things that will be helpful to as large a set of users as possible). + +There are also specific `Dockerfile` writing guidelines which can be found in [the "Review Guidelines" section of our documentation](https://github.com/docker-library/official-images#review-guidelines), which is used as a basis for a lot of our review process. + ### What is `bashbrew`? Where can I download it? The `bashbrew` tool is one built by the official images team for the purposes of building and pushing the images. At a very high level, it's a wrapper around `git` and `docker build` in order to help us manage the various `library/xxx` files in the main official images repository in a simple and repeatable way (especially focused around using explicit Git commits in order to achieve maximum repeatability and `Dockerfile` source change reviewability). @@ -214,6 +222,12 @@ Sure! Just a few simple guidelines/requests: 3. only one PR at a time, please (the easiest way to accomplish this is to use the same branch name every time) 4. base every new PR off the `master` branch from https://github.com/docker-library/official-images, *not* from your fork (especially important if we squash-merge your PRs) +### Is my project a good fit to be included in the Official Images library? + +See the the more detailed section on this over at https://github.com/docker-library/official-images#review-guidelines + +Essentially new image proposals are generally considered with regard to the [New Image Checklist](https://github.com/docker-library/official-images/blob/master/NEW-IMAGE-CHECKLIST.md). Notably things like "does it fit into one of the common categories? ("service", "language stack", "base distribution")", and "is it reasonably popular, or does it solve a particular use case well?" + ## Image Usage ### `--link` is deprecated!