From bdb8ead72c985942c922a0237a4cba0953b9faa3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9line=20Souchet?= Date: Wed, 16 Sep 2020 17:30:33 +0200 Subject: [PATCH] Update the contributing section of the readme --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 973c697979..5e0feeba99 100644 --- a/README.md +++ b/README.md @@ -50,10 +50,18 @@ Then, we will work on BPMN extensions, library extension points, display options capacities. -# Development +# Contributing -To build the project, see the [Contributing guide](CONTRIBUTING.md#Build) :slightly_smiling_face: +To contribute to `bpmn-visualization`, fork and clone this repo locally and commit your code on a separate branch. \ +Please write tests for your code before opening a pull-request: +```sh +npm run test # run all unit & e2e tests +``` + +You can find more detail in our [Contributing guide](CONTRIBUTING.md#Build). Participation in this open source project is subject to a [Code of Conduct](CODE_OF_CONDUCT.md). + +:sparkles: A BIG thanks to all our contributors :slightly_smiling_face: # License