bpmn-io / bpmnlint

Validate BPMN diagrams based on configurable lint rules.
MIT License
121 stars 36 forks source link

Document `no-inclusive-gateway` rule #44

Closed barmac closed 3 years ago

barmac commented 3 years ago

Is your feature request related to a problem? Please describe

Currently, no-inclusive-gateway is a rule in the recommended set. However, the documentation does not give grounds why this element should be disallowed. I couldn't find any sources which would discourage usage of this gateway. This has already caused confusion on Camunda forum.

Describe the solution you'd like

Add grounds why rule exists and should be used.

Describe alternatives you've considered

Remove the rule from the recommended set, but it has already been decided against in https://github.com/bpmn-io/bpmnlint/issues/41#issuecomment-580213851

Additional context

https://forum.camunda.org/t/linter-plugin-error-element-has-disallowed-type-bpmn-inclusivegateway/23320

pinussilvestrus commented 3 years ago

Related: https://github.com/bpmn-io/bpmnlint/issues/41#issuecomment-580213851

barmac commented 3 years ago

Related: #41 (comment)

Thanks! I will update the issue so that it does not contain removal request anymore.