From f30da273549316876a19cbf3a284a325e33d46d1 Mon Sep 17 00:00:00 2001 From: Alexander Zeitler Date: Sat, 26 Oct 2019 22:53:02 +0200 Subject: [PATCH] docs: add conventional commits badge and contribution info --- readme.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index b4c5d06..1681bff 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ - +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) # Manage Docker-Compose via Node.js @@ -99,6 +99,8 @@ If you see a bug, please be so kind as to show how it's failing, and we'll do ou Before sending a PR, please [create an issue](https://github.com/PDMLab/docker-compose/issues/new) to introduce your idea and have a reference for your PR. +We're using [conventional commits](https://www.conventionalcommits.org), so please use it for your commits as well. + Also please add tests and make sure to run `npm run eslint`. ### Slack