From 788bcf3c4864630a36752695c7c7a0d7be7f1b7f Mon Sep 17 00:00:00 2001 From: Nico Rehwaldt Date: Wed, 1 Apr 2015 13:50:32 +0200 Subject: [PATCH] docs(CONTRIBUTING): swap paragraphs Putting up issues first, it is the first stuff possible contributors are going to read. Scrolling is hard. --- CONTRIBUTING.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e31d016..f76f52da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,23 @@ We love you to contribute to this project by filing bugs, helping others on the [issue tracker](https://github.com/bpmn-io/bpmn-js/issues), by contributing features/bug fixes through pull requests or by helping out in our [forums](https://forum.bpmn.io/). -## How to start with bpmn-js -The bpmn-js runs on top of the diagram-js master branch. The following code snippet sets up both libraries linking diagram-js to bpmn-js. +## Creating issues + +We use our [issue tracker](https://github.com/bpmn-io/bpmn-js/issues) for project communication. +When using the issue tracker, + +* Be descriptive when creating an issue (what, where, when and how does a problem pop up)? +* Attach steps to reproduce (if applicable) +* Attach code samples, configuration options or stack traces that may indicate a problem +* Be helpful and respect others when commenting + +Create a pull request if you would like to have an in-depth discussion about some piece of code. + + +## Setting up the project locally + +The project development runs on top of the [diagram-js](https://github.com/bpmn-io/diagram-js) master branch. The following code snippet sets up both libraries linking diagram-js to bpmn-js. mkdir bpmn.io cd bpmn.io @@ -21,17 +35,6 @@ The bpmn-js runs on top of the diagram-js master branch. The following code snip // Running the test suite with every file change TEST_BROWSERS=(Chrome|Firefox|IE) grunt auto-test -## Working with issues - -We use our [issue tracker](https://github.com/bpmn-io/bpmn-js/issues) for project communication. -When using the issue tracker, - -* Be descriptive when creating an issue (what, where, when and how does a problem pop up)? -* Attach steps to reproduce (if applicable) -* Attach code samples, configuration options or stack traces that may indicate a problem -* Be helpful and respect others when commenting - -Create a pull request if you would like to have an in-depth discussion about some piece of code. ## Creating pull requests @@ -49,4 +52,4 @@ Some things that make it easier for us to accept your pull requests * The commit messages adhere to our [guideline](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y) -We'd be glad to assist you if you do not get these things right in the first place. \ No newline at end of file +We'd be glad to assist you if you do not get these things right in the first place.