From e1553d1844f545b685a3189dc54f45f3d112dca1 Mon Sep 17 00:00:00 2001 From: Pedro Amador Date: Mon, 10 Feb 2020 15:48:15 +0000 Subject: [PATCH] Docs: Add contributing info --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bf63daa --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +## Issues + +Issues are always very welcome. + +### Tell us + +* What you are doing? + * Post sample use case that reproduces the issue. Attaching the entire Dockerfile is the best option +* What do you expect to happen? +* What is actually happening? + +When you post code, please use [Github flavored markdown](https://help.github.com/articles/github-flavored-markdown), in order to get proper syntax highlighting! + +## Pull requests + +Open a PR to the `develop` branch with your contribution. + +## Coding Guidelines + +As part of the test process, all commit messages will be linted, and your PR will **not** be accepted if it does not pass linting.