docs: Create contributing (#30)

This commit is contained in:
G r e y 2020-11-14 14:38:51 -05:00 committed by GitHub
parent 17d44ef4aa
commit d5acf1b285
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 11 deletions

12
.github/CONTRIBUTING.md vendored Normal file
View File

@ -0,0 +1,12 @@
## Adding a New Image
To add a new image, create a new folder in `images/` with the name of the image, and create
at least one `Dockerfile` for it, using an extension as the tag. For instance, an Ubuntu-based
version of your image would be in `Dockerfile.ubuntu`.
New images should extend from existing images whenever possible, e.g.
```Dockerfile
FROM codercom/enterprise-base:ubuntu
# Rest of your image...
```

View File

@ -31,15 +31,6 @@ repository. For example, `intellij` is available at https://hub.docker.com/r/cod
The tag is taken from the file extension of the Dockerfile. For example, `intellij/Dockerfile.ubuntu`
is under the `ubuntu` tag.
## Adding a New Image
## Contributing
To add a new image, create a new folder in `images/` with the name of the image, and create
at least one `Dockerfile` for it, using an extension as the tag. For instance, an Ubuntu-based
version of your image would be in `Dockerfile.ubuntu`.
New images should extend from existing images whenever possible, e.g.
```Dockerfile
FROM codercom/enterprise-base:ubuntu
# Rest of your image...
```
See our [contributing guide](.github/CONTRIBUTING.md).