sartography
/
bpmn-js
mirror of https://github.com/sartography/bpmn-js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: move single run to CONTRIBUTING guide 

Also featured directly on the front-page (README).
This commit is contained in:
Nico Rehwaldt 2020-12-21 13:43:19 +01:00 committed by Nico Rehwaldt
parent 589b0e2bf9
commit 0d2e36c304
2 changed files with 23 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
.github/CONTRIBUTING.md vendored
View File

@ -35,7 +35,7 @@ Learn how to setup the project locally, make changes and contribute bug fixes an
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. 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.
```plain ```sh
mkdir bpmn.io mkdir bpmn.io
cd bpmn.io cd bpmn.io
@ -44,17 +44,32 @@ git clone git@github.com:bpmn-io/diagram-js.git
git clone git@github.com:bpmn-io/bpmn-js.git git clone git@github.com:bpmn-io/bpmn-js.git
(cd bpmn-js && npm install && npm link ../diagram-js) (cd bpmn-js && npm install && npm link ../diagram-js)
// Run the test suite
npm test
// Running the test suite with every file change
TEST_BROWSERS=(Chrome|Firefox|IE) npm run dev
``` ```
For details consult our in depth [setup guide](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/SETUP.md). For details consult our in depth [setup guide](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/SETUP.md).
### Build and Run the Project
Spin up a single modeler instance for local inspection:
```sh
npm start
```
Spin up the development environment, re-run tests with every file change:
```sh
TEST_BROWSERS=(Chrome|Firefox|IE) npm run dev
```
Build, lint, and test the project, just as the CI does.
```sh
npm run all
```
### Discussing Code Changes ### Discussing Code Changes
Create a [pull request](#creating-a-pull-request) if you would like to have an in-depth discussion about some piece of code. Create a [pull request](#creating-a-pull-request) if you would like to have an in-depth discussion about some piece of code.

23
docs/project/SETUP.md
View File

@ -63,25 +63,4 @@ Execute `npm run all` on each project. Things should be fine.
### Setup via Script ### Setup via Script
The whole setup can be automated through setup scripts for [Linux/OS X](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.sh) and [Windows](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.bat). The whole setup can be automated through setup scripts for [Linux/OS X](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.sh) and [Windows](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/setup.bat).
### Running a single modeler instance
To test changes that you might have made in [bpmn-js](https://github.com/bpmn-io/bpmn-js) or in any of the libraries it depends on,
you can run a single test that will instantiate a modeler with all the core modules.
* Open the [file testing the modeler](https://github.com/bpmn-io/bpmn-js/blob/master/test/spec/ModelerSpec.js#L49)
* Change
```javascript
it('should import simple process', function() {
```
to
```javascript
it.only('should import simple process', function() {
```
(This ensures only this single test is run)
* Execute `npm run dev`
* Open your browser to <localhost:9876/debug.html>
* Interact with the modeler and see your changes reflected