style: update markdown formatting

camunda · Jul 31, 2024 · 7a2a860 · 7a2a860
1 parent be98148
commit 7a2a860
Show file tree

Hide file tree

Showing 7 changed files with 130 additions and 137 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -2,28 +2,25 @@
 
 Great to see you! Help us out by [filing bugs or feature requests](#working-with-issues), assisting others in our [forums](https://forum.camunda.io/c/bpmn-modeling/) or by [contributing improvements](#contributing-improvements).
 
-
 ## Table of Contents
 
 * [Working with Issues](#working-with-issues)
-    * [Helping out](#helping-out)
+  * [Helping out](#helping-out)
 * [Contributing Improvements](#contributing-improvements)
-    * [Setting up the Project](#setting-up-the-project)
-    * [Discussing Code Changes](#discussing-code-changes)
-    * [Creating a Pull Request](#creating-a-pull-request)
-
+  * [Setting up the Project](#setting-up-the-project)
+  * [Discussing Code Changes](#discussing-code-changes)
+  * [Code Style](#code-style)
+  * [Creating a Pull Request](#creating-a-pull-request)
 
 ## Working with Issues
 
 We use our [issue tracker](https://github.com/camunda/camunda-modeler/issues) for project communication, discussion and planning.
 
-
 ### Helping out
 
 * Share your perspective on issues
 * Be helpful and respect others when commenting
 
-
 ## Contributing Improvements
 
 Learn how to setup the project locally, make changes and contribute bug fixes and new features through pull requests.
@@ -50,7 +47,6 @@ npm run all
 
 Create a [pull request](#creating-a-pull-request) if you would like to have an in-depth discussion about some piece of code.
 
-
 ### Code Style
 
 In addition to our automatically enforced [lint rules](https://github.com/bpmn-io/eslint-plugin-bpmn-io), please adhere to the following conventions:
@@ -65,16 +61,14 @@ 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.
 
-
 :heart: from the bpmn.io team.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -10,9 +10,9 @@ steps to try out your changes.
 
 To ensure you provided everything we need to look at your PR:
 
-* [ ] **Brief textual description** of the changes present
-* [ ] **Visual demo** attached
-* [ ] **Steps to try out** present, i.e. [using the `@bpmn-io/sr` tool](https://github.com/bpmn-io/sr)
+* [ ] __Brief textual description__ of the changes present
+* [ ] __Visual demo__ attached
+* [ ] __Steps to try out__ present, i.e. [using the `@bpmn-io/sr` tool](https://github.com/bpmn-io/sr)
 * [ ] Related issue linked via `Closes {LINK_TO_ISSUE}` or `Related to {LINK_TO_ISSUE}`
 
 <!--

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -186,7 +186,6 @@ ___Note:__ Yet to be released changes appear here._
 * `FIX`: prevent crash when illegal key and path is used ([#4217](https://github.com/camunda/camunda-modeler/issues/4217), [#4218](https://github.com/camunda/camunda-modeler/issues/4218))
 * `FIX`: make the output panel readonly ([#4216](https://github.com/camunda/camunda-modeler/issues/4216))
 
-
 ## 5.21.0
 
 ### General
@@ -394,7 +393,7 @@ ___Note:__ Yet to be released changes appear here._
 * `FEAT`: add toggle for non-interrupting events ([bpmn-io/bpmn-js#2000](https://github.com/bpmn-io/bpmn-js/pull/2000))
 * `FEAT`: keep events non-interrupting when using `bpmnReplace` by default ([bpmn-io/bpmn-js#2000](https://github.com/bpmn-io/bpmn-js/pull/2000))
 * `FEAT`: preview append on hover ([bpmn-io/bpmn-js#1985](https://github.com/bpmn-io/bpmn-js/pull/1985))
-* `FEAT`: align selection outline with element's shape ([bpmn-io/bpmn-io/bpmn-js#1996]((https://github.com/bpmn-io/bpmn-js/pull/1985)))
+* `FEAT`: align selection outline with element's shape ([bpmn-io/bpmn-io/bpmn-js#1996](https://github.com/bpmn-io/bpmn-js/pull/1985))
 * `FEAT`: make space tool local per default ([bpmn-io/diagram-js#811](https://github.com/bpmn-io/diagram-js/pull/811), [bpmn-io/bpmn-js#1975](https://github.com/bpmn-io/bpmn-js/issues/1975))
 * `FEAT`: support Camunda 8 form reference ([bpmn-io/bpmn-js-properties-panel#978](https://github.com/bpmn-io/bpmn-js-properties-panel/pull/978), [bpmn-io/bpmn-js-properties-panel#949](https://github.com/bpmn-io/bpmn-js-properties-panel/issues/949))
 * `FEAT`: add link to learning resources from the FEEL popup editor ([@bpmn-io/properties-panel#308](https://github.com/bpmn-io/properties-panel/pull/308))
@@ -426,12 +425,12 @@ ___Note:__ Yet to be released changes appear here._
 * `FEAT`: drop missleading audience hint in deploy dialog ([#3864](https://github.com/camunda/camunda-modeler/issues/3864))
 * `FEAT`: improve error messages shown in deploy dialog ([#3808](https://github.com/camunda/camunda-modeler/issues/3808), [#3873](https://github.com/camunda/camunda-modeler/pull/3873))
 * `FEAT`: mark `8.3` as stable ([#3882](https://github.com/camunda/camunda-modeler/issues/3882))
-* `DEPS`: update to [email protected]
-* `DEPS`: update to [email protected]
-* `DEPS`: update to [email protected]
-* `DEPS`: update to [email protected]
-* `DEPS`: update to [email protected]
-* `DEPS`: update to [email protected]
+* `DEPS`: update to `[email protected]`
+* `DEPS`: update to `[email protected]`
+* `DEPS`: update to `[email protected]`
+* `DEPS`: update to `[email protected]`
+* `DEPS`: update to `[email protected]`
+* `DEPS`: update to `[email protected]`
 
 ### BPMN
 
@@ -442,6 +441,7 @@ ___Note:__ Yet to be released changes appear here._
 * `FIX`: correct dirty marker not updating ([#3815](https://github.com/camunda/camunda-modeler/issues/3815))
 * `FIX`: correct HTTL incorrectly reported as error ([#3853](https://github.com/camunda/camunda-modeler/issues/3853))
 *
+
 ### Forms
 
 * `FEAT`: support group component ([bpmn-io/form-js#768](https://github.com/bpmn-io/form-js/pull/768))
@@ -467,11 +467,11 @@ ___Note:__ Yet to be released changes appear here._
 
 ### General
 
-* `DEPS` update to @bpmn-io/properties-panel@3.4.0
-* `DEPS` update to @camunda/linting@3.7.1
-* `DEPS` update to [email protected]
-* `DEPS` update to [email protected]
-* `DEPS` update to [email protected]
+* `DEPS` update to `@bpmn-io/[email protected]`
+* `DEPS` update to `@camunda/[email protected]`
+* `DEPS` update to `[email protected]`
+* `DEPS` update to `[email protected]`
+* `DEPS` update to `[email protected]`
 
 ### BPMN
 
@@ -529,7 +529,6 @@ ___Note:__ Yet to be released changes appear here._
 * `DEPS`: update to `form-linting` to 0.10.0
 * `DEPS`: update to `form-playground` to 0.8.0
 
-
 ## 5.13.0
 
 ### General

diff --git a/docs/.project/INTEGRATION_TEST.md b/docs/.project/INTEGRATION_TEST.md
@@ -1,144 +1,144 @@
-> **Note:** If possible, execute the integration test on our [released artifacts](https://github.com/camunda/camunda-modeler/releases).
+> __Note:__ If possible, execute the integration test on our [released artifacts](https://github.com/camunda/camunda-modeler/releases).
 
 # Integration Test
 
 We use a number of pre-defined steps to ensure the stability of our releases through integration tests.
 
-**Target:** Perform tests on nightly builds on supported platforms.
+__Target:__ Perform tests on nightly builds on supported platforms.
 
 ### Test Procedure
 
-- [ ] fetch [latest release/nightly](https://camunda.org/release/camunda-modeler/)
-- [ ] fetch [latest version of A11y-checker plugin](https://github.com/bpmn-io/camunda-modeler-plugin-a11y-checker)
-- [ ] test changes of the release from the users' perspective end-2-end (e.g., include deployment where appropriate) (see [release issue](https://github.com/camunda/camunda-modeler/labels/release) and [changelog](https://github.com/camunda/camunda-modeler/blob/develop/CHANGELOG.md))
-- [ ] click like crazy (see [below](#test-checklist))
+* [ ] fetch [latest release/nightly](https://camunda.org/release/camunda-modeler/)
+* [ ] fetch [latest version of A11y-checker plugin](https://github.com/bpmn-io/camunda-modeler-plugin-a11y-checker)
+* [ ] test changes of the release from the users' perspective end-2-end (e.g., include deployment where appropriate) (see [release issue](https://github.com/camunda/camunda-modeler/labels/release) and [changelog](https://github.com/camunda/camunda-modeler/blob/develop/CHANGELOG.md))
+* [ ] click like crazy (see [below](#test-checklist))
 
 ### Test Checklist
 
 Manual integration tests:
 
 #### BPMN Modeling
 
-- [ ] create a new BPMN diagram
-- [ ] build [this diagram](./test.bpmn.png) from scratch
-- [ ] save file on disk as `test.bpmn`
-- [ ] save file with other file name on disk
-- [ ] export as SVG
-- [ ] export as PNG
-- [ ] export as JPG
-- [ ] SVG, PNG and JPG exports open in browser
+* [ ] create a new BPMN diagram
+* [ ] build [this diagram](./test.bpmn.png) from scratch
+* [ ] save file on disk as `test.bpmn`
+* [ ] save file with other file name on disk
+* [ ] export as SVG
+* [ ] export as PNG
+* [ ] export as JPG
+* [ ] SVG, PNG and JPG exports open in browser
 
 ##### Copy/Paste
 
-- [ ] create a new diagram
-- [ ] `CTRL + A` + `CTRL + C` in previously created diagram
-- [ ] remove start event in empty diagram
-- [ ] `CTRL + V` in empty diagram pastes all contents
+* [ ] create a new diagram
+* [ ] `CTRL + A` + `CTRL + C` in previously created diagram
+* [ ] remove start event in empty diagram
+* [ ] `CTRL + V` in empty diagram pastes all contents
 
 ##### BPMN properties panel
 
-- [ ] configure service task in properties panel
-- [ ] add `async:before`
-- [ ] add execution listener
-- [ ] add input mapping
-- [ ] verify results in XML tab
+* [ ] configure service task in properties panel
+* [ ] add `async:before`
+* [ ] add execution listener
+* [ ] add input mapping
+* [ ] verify results in XML tab
 
 ##### Keep implementation Details (Copy/Paste and Morph)
 
 Based on the [test diagram](./test.bpmn.png):
 
-- [ ] Add Form configuration (FormField + FormData) to "Inspect Invoice" UserTask
-  - [ ] Copy / Paste task; properties are kept
-  - [ ] Change task to ServiceTask; properties are gone from XML
-  - [ ] Undo last step `CTRL + Z`; properties are back
-  - [ ] Redo last step `CTRL + Y`; Task changed to Service Task without form properties
-- [ ] Add Properties, Input/Output Mapping, `asyncBefore`, Retry Time Cycle and implementation to "Check" ServiceTask
-  - [ ] Copy / Paste task; properties are kept
-  - [ ] Change task to Send Task; properties are kept
-  - [ ] Change task to UserTask; implementation property is gone from XML (except Retry Time Cycle, Input/output Mapping and `asyncBefore`)
+* [ ] Add Form configuration (FormField + FormData) to "Inspect Invoice" UserTask
+  * [ ] Copy / Paste task; properties are kept
+  * [ ] Change task to ServiceTask; properties are gone from XML
+  * [ ] Undo last step `CTRL + Z`; properties are back
+  * [ ] Redo last step `CTRL + Y`; Task changed to Service Task without form properties
+* [ ] Add Properties, Input/Output Mapping, `asyncBefore`, Retry Time Cycle and implementation to "Check" ServiceTask
+  * [ ] Copy / Paste task; properties are kept
+  * [ ] Change task to Send Task; properties are kept
+  * [ ] Change task to UserTask; implementation property is gone from XML (except Retry Time Cycle, Input/output Mapping and `asyncBefore`)
 
 #### Version chooser
 
-- [ ] I can select the latest (alpha?) version of a diagram
-  - [ ] For Camunda 7, BPMN, validation works
-  - [ ] For Camunda 8, BPMN, validation works
+* [ ] I can select the latest (alpha?) version of a diagram
+  * [ ] For Camunda 7, BPMN, validation works
+  * [ ] For Camunda 8, BPMN, validation works
 
 #### Problems panel
 
-- [ ] In a Camunda 8 BPMN the problems panel indicates missing implementation details
-- [ ] In a Camunda 7 BPMN diagram the problems panel indicates missing HTTL (`Process > History time to live`)
+* [ ] In a Camunda 8 BPMN the problems panel indicates missing implementation details
+* [ ] In a Camunda 7 BPMN diagram the problems panel indicates missing HTTL (`Process > History time to live`)
 
 #### DMN modeling
 
-- [ ] create a new DMN diagram
-- [ ] build [this diagram](./test.dmn.png) from scratch
-- [ ] morph `Go on Holidays` to a decision table
-- [ ] morph `Which Season` to a decision table
-- [ ] morph `Which Region` to a literal expression
-- [ ] click onto blue overlay on `Go on Holidays` jumps into table editing mode
-- [ ] changing name reflects in DRD
-- [ ] save file on disk as `test.dmn` from table editing mode
-- [ ] save file on disk as `test2.dmn` from diagram mode
-- [ ] both import correctly after save
-- [ ] export DRD as SVG
-- [ ] export DRD as PNG
-- [ ] export DRD as JPG
-- [ ] SVG, PNG and JPG exports open in browser
+* [ ] create a new DMN diagram
+* [ ] build [this diagram](./test.dmn.png) from scratch
+* [ ] morph `Go on Holidays` to a decision table
+* [ ] morph `Which Season` to a decision table
+* [ ] morph `Which Region` to a literal expression
+* [ ] click onto blue overlay on `Go on Holidays` jumps into table editing mode
+* [ ] changing name reflects in DRD
+* [ ] save file on disk as `test.dmn` from table editing mode
+* [ ] save file on disk as `test2.dmn` from diagram mode
+* [ ] both import correctly after save
+* [ ] export DRD as SVG
+* [ ] export DRD as PNG
+* [ ] export DRD as JPG
+* [ ] SVG, PNG and JPG exports open in browser
 
 #### Forms modeling
 
-- [ ] create a new Camunda Form
-- [ ] build [this form](./test.form.png) from scratch
-- [ ] add a regular expression (`^CAM-[0-9]+$`) to the invoice number field
-- [ ] save file on disk as `test.form`
-- [ ] file imports correctly after save
-- [ ] Set the **Execution Platform Version** to `Camunda 8 (Zeebe 1.0)`
-  - [ ] 4 errors are shown: `Text`, `Number`, `Checkbox`, and `Radio` are not supported
-  - [ ] Clicking on an error focuses the respective element
-- [ ] Set the **Execution Platform Version** to `Camunda 8 (Zeebe 1.2)`
-  - [ ] 0 errors are shown
+* [ ] create a new Camunda Form
+* [ ] build [this form](./test.form.png) from scratch
+* [ ] add a regular expression (`^CAM-[0-9]+$`) to the invoice number field
+* [ ] save file on disk as `test.form`
+* [ ] file imports correctly after save
+* [ ] Set the __Execution Platform Version__ to `Camunda 8 (Zeebe 1.0)`
+  * [ ] 4 errors are shown: `Text`, `Number`, `Checkbox`, and `Radio` are not supported
+  * [ ] Clicking on an error focuses the respective element
+* [ ] Set the __Execution Platform Version__ to `Camunda 8 (Zeebe 1.2)`
+  * [ ] 0 errors are shown
 
 #### BPMN + Camunda Forms deployment
 
-- [ ] Create a simple `Start Event -> User Task -> End Event` process
-- [ ] Create a simple form with id `foo`
-- [ ] Reference the form in the user task via `Camunda Forms -> reference=foo`
-- [ ] Verify that deployment of BPMN + Form file works
+* [ ] Create a simple `Start Event -> User Task -> End Event` process
+* [ ] Create a simple form with id `foo`
+* [ ] Reference the form in the user task via `Camunda Forms -> reference=foo`
+* [ ] Verify that deployment of BPMN + Form file works
 
 #### FS integration (platform specific)
 
-- [ ] external change detection works
-  - [ ] change file in external editor
-  - [ ] focus editor with file open
-  - [ ] message to reload displays
-- [ ] double click in FS opens file in editor (existing instance _?_)
-  - [ ] `.bpmn`
-  - [ ] `.dmn`
-  - [ ] `.form`
+* [ ] external change detection works
+  * [ ] change file in external editor
+  * [ ] focus editor with file open
+  * [ ] message to reload displays
+* [ ] double click in FS opens file in editor (existing instance _?_)
+  * [ ] `.bpmn`
+  * [ ] `.dmn`
+  * [ ] `.form`
 
 #### Error Handling
 
-- [ ] Open [`broken.bpmn`](./broken.bpmn) and verify a proper error message is shown (_No diagram to display_)
+* [ ] Open [`broken.bpmn`](./broken.bpmn) and verify a proper error message is shown (_No diagram to display_)
 
 #### Accessibility
 
-- [ ] No new issues were reported during the tests
-- [ ] The modal opened via "Accessibility issues" button is empty
+* [ ] No new issues were reported during the tests
+* [ ] The modal opened via "Accessibility issues" button is empty
 
 #### Installers (platform specific)
 
-- [ ] MacOS
-  - [ ] [Downloading archive](https://github.com/camunda/camunda-modeler/releases), extracting and starting application works
-  - [ ] [Downloading DMG](https://github.com/camunda/camunda-modeler/releases), installing and starting it works
+* [ ] MacOS
+  * [ ] [Downloading archive](https://github.com/camunda/camunda-modeler/releases), extracting and starting application works
+  * [ ] [Downloading DMG](https://github.com/camunda/camunda-modeler/releases), installing and starting it works
 
 #### Other (platform specific)
 
-- [ ] key bindings work (Mac = CMD, CMD+SHIFT+Z, Other = CTRL)
-- [ ] restore workspace on reopen (diagrams, properties panel)
-- [ ] drag and drop
-- [ ] icons are present
-- [ ] OS specific menus are being displayed
-- [ ] menu bar (icons, correctly disabled + enabled)
-- [ ] correct modeler version displayed in about menu
-- [ ] [flags](https://docs.camunda.io/docs/components/modeler/desktop-modeler/flags/) work (e.g., start with `$ ./camunda-modeler --no-disable-cmmn` or provide flag in [`flags.json` file](https://github.com/camunda/camunda-modeler/tree/develop/docs/flags#configure-in-flagsjson) => CMMN diagrams can be created)
-  - Note: On MacOS, you need to `$ cd Camunda\ Modeler.app/Contents/MacOS` first.
+* [ ] key bindings work (Mac = CMD, CMD+SHIFT+Z, Other = CTRL)
+* [ ] restore workspace on reopen (diagrams, properties panel)
+* [ ] drag and drop
+* [ ] icons are present
+* [ ] OS specific menus are being displayed
+* [ ] menu bar (icons, correctly disabled + enabled)
+* [ ] correct modeler version displayed in about menu
+* [ ] [flags](https://docs.camunda.io/docs/components/modeler/desktop-modeler/flags/) work (e.g., start with `$ ./camunda-modeler --no-disable-cmmn` or provide flag in [`flags.json` file](https://github.com/camunda/camunda-modeler/tree/develop/docs/flags#configure-in-flagsjson) => CMMN diagrams can be created)
+  * Note: On MacOS, you need to `$ cd Camunda\ Modeler.app/Contents/MacOS` first.