diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e7c30736..c64dae91 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,20 +2,17 @@ Great to see you! Help us out by [filing bugs or feature requests](#work-with-issues), assisting others [in our forums](https://forum.bpmn.io/), or [contributing improvements](#contribute-improvements). - ## Table of Contents * [Work with Issues](#work-with-issues) - * [Create an Issue](#Create-an-issue) - * [Help Out](#help-out) + * [Create an Issue](#create-an-issue) + * [Help Out](#help-out) * [Contribute Improvements](#contribute-improvements) - * [Setup the Project](#Setup-the-project) - * [Build and Run the Project](#build-and-run-the-project) - * [Discuss Code Changes](#discuss-code-changes) - * [Adhere to the Code Style](#adhere-to-the-code-style) - * [Adhere to the Unit Test Style](#adhere-to-the-unit-test-style) - * [Create a Pull Request](#create-a-pull-request) - + * [Setup the Project](#setup-the-project) + * [Build and Run the Project](#build-and-run-the-project) + * [Discuss Code Changes](#discuss-code-changes) + * [Adhere to the Unit Test Style](#adhere-to-the-unit-test-style) + * [Create a Pull Request](#create-a-pull-request) ## Work with Issues @@ -30,7 +27,6 @@ File bug reports or feature requests via [our issue tracker](https://github.com/ * Share your perspective on issues * Be helpful and respect others when commenting - ## Contribute Improvements Learn how to set up the project locally, make changes, and contribute bug fixes and new features through pull requests. @@ -52,7 +48,6 @@ git clone git@github.com:bpmn-io/bpmn-js.git For details consult our in depth [setup guide](../docs/project/SETUP.md). - ### Build and Run the Project Spin up a single modeler instance for local inspection: @@ -79,14 +74,13 @@ Build, lint, and test the project, just as the CI does. npm run all ``` - ### Discuss Code Changes Create a [pull request](#create-a-pull-request) if you would like to have an in-depth discussion about some piece of code. ### Adhere to the Unit Test Style -In order to retrieve a sign-off for your contribution, it needs to be sufficiently and well tested. Please structure your unit tests into **given**, **when** and **then** ([ModelerSpec example](https://github.com/bpmn-io/bpmn-js/blob/develop/test/spec/ModelerSpec.js#L116), [ResizeBehaviorSpec example](https://github.com/bpmn-io/bpmn-js/blob/develop/test/spec/features/modeling/behavior/ResizeBehaviorSpec.js#L38)). To increase overall readability and understandability please also leave two empty lines before `describe(...)`, `it(...)` or *setup* blocks on the same indentation level ([ModelerSpec example](https://github.com/bpmn-io/bpmn-js/blob/develop/test/spec/ModelerSpec.js#L49), [ResizeBehaviorSpec example](https://github.com/bpmn-io/bpmn-js/blob/develop/test/spec/features/modeling/behavior/ResizeBehaviorSpec.js#L36)). +In order to retrieve a sign-off for your contribution, it needs to be sufficiently and well tested. Please structure your unit tests into __given__, __when__ and __then__ ([ModelerSpec example](https://github.com/bpmn-io/bpmn-js/blob/develop/test/spec/ModelerSpec.js#L116), [ResizeBehaviorSpec example](https://github.com/bpmn-io/bpmn-js/blob/develop/test/spec/features/modeling/behavior/ResizeBehaviorSpec.js#L38)). To increase overall readability and understandability please also leave two empty lines before `describe(...)`, `it(...)` or _setup_ blocks on the same indentation level ([ModelerSpec example](https://github.com/bpmn-io/bpmn-js/blob/develop/test/spec/ModelerSpec.js#L49), [ResizeBehaviorSpec example](https://github.com/bpmn-io/bpmn-js/blob/develop/test/spec/features/modeling/behavior/ResizeBehaviorSpec.js#L36)). ### Create a Pull Request @@ -95,18 +89,16 @@ We use pull requests for feature additions and bug fixes. If you are not yet fam Some things that make it easier for us to accept your pull requests * The code adheres to our conventions - * spaces instead of tabs - * single-quotes - * ... + * spaces instead of tabs + * single-quotes + * ... * The code is tested * The `npm run all` build passes (executes tests + linting) * The work is combined into a single commit * The commit messages adhere to the [conventional commits guidelines](https://www.conventionalcommits.org) - We'd be glad to assist you if you do not get these things right in the first place. - --- Thanks for your interest in our library. diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f128ef6..83392ac3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -370,20 +370,20 @@ ___Note:__ Yet to be released changes appear here._ ## 14.1.3 -* `CHORE`: correctly output tag in https://github.com/bpmn-io/bpmn-js/pull/1982 +* `CHORE`: correctly output tag in [#1982](https://github.com/bpmn-io/bpmn-js/pull/1982) ## 14.1.2 -* `CHORE`: fix POST_RELEASE job in https://github.com/bpmn-io/bpmn-js/pull/1980 +* `CHORE`: fix POST_RELEASE job in [#1980](https://github.com/bpmn-io/bpmn-js/pull/1980) ## 14.1.1 -* `FIX`: asset path by @nikku in https://github.com/bpmn-io/bpmn-js/pull/1977 +* `FIX`: asset path by [__@nikku__](https://github.com/nikku) in [#1977](https://github.com/bpmn-io/bpmn-js/pull/1977) ## 14.1.0 -* `FEAT`: ensure lanes aren't resized when using space tool in https://github.com/bpmn-io/bpmn-js/pull/1972 -* `DOCS`: update translations for v14.0.0 by @bpmn-io-bot in https://github.com/bpmn-io/bpmn-js/pull/1948 +* `FEAT`: ensure lanes aren't resized when using space tool in [#1972](https://github.com/bpmn-io/bpmn-js/pull/1972) +* `DOCS`: update translations for v14.0.0 by [__@bpmn-io-bot__](https://github.com/bpmn-io-bot) in [#1948](https://github.com/bpmn-io/bpmn-js/pull/1948) ## 14.0.0 diff --git a/README.md b/README.md index 62332f3d..badc0958 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ bpmn-js builds on top of a few powerful tools: * [bpmn-moddle](https://github.com/bpmn-io/bpmn-moddle): Read / write support for BPMN 2.0 XML in the browsers * [diagram-js](https://github.com/bpmn-io/diagram-js): Diagram rendering and editing toolkit -It is an extensible toolkit, complemented by many [additional utilities](https://github.com/bpmn-io/awesome-bpmn-io). +It is an extensible toolkit, complemented by many [additional utilities](https://github.com/bpmn-io/awesome-bpmn-io). ## License