From 1ca17baaa42a4e9da1520d20a58be557511972b6 Mon Sep 17 00:00:00 2001 From: Laurent Goderre Date: Thu, 13 Apr 2017 08:53:54 -0400 Subject: [PATCH] Add a contributing documentation file Added a section about dependencies since it's one of the most common contribution. --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..4008beaca3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,7 @@ +# Contributing to docker-node + +Thank you for your contribution. Here are a set of guidelines for contributing to the docker-node project. + +## Adding dependencies to the base images + +NodeJS is a big ecosystem with a variety of different use cases. The docker images for node are designed to provide the minimum for running core node. Additional dependencies (including dependencies for npm or yarn such as git) will not be included in these base images and will need to be included in descendent image. We however maintain a list of common dependencies you can add to your image (TODO).