Skip to content

Commit

Permalink
docu
Browse files Browse the repository at this point in the history
  • Loading branch information
rsoika committed Aug 2, 2024
1 parent 81b0fed commit 56fd53e
Show file tree
Hide file tree
Showing 2 changed files with 110 additions and 61 deletions.
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Contributing to Open-BPMN

Thank you for your interest in the Open-BPMN project!
The following is a set of guidelines for contributing to Open-BPMN.

## Code of Conduct

This project is governed by the [Eclipse Community Code of Conduct](https://github.com/eclipse/.github/blob/master/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.

## Communication

The following communication channels are available:

- [GitHub issues](https://github.com/imixs/open-bpmn/issues) - for bug reports, feature requests, etc.
- [GitHub Discussions](https://github.com/imixs/open-bpmn/discussions) - for questions

In case you have a question, please look into the [GitHub Discussions](https://github.com/imixs/open-bpmn/discussions) first.
If you don't find any answer there, feel free to start a new discussion or create a new [issue](https://github.com/imixs/open-bpmn/issues) to get help.


## How to Contribute

In order to contribute, please first open an issue in this project, irrespectively whether this bug or feature concerns the glsp-client, glsp-server, or one of the platform integrations.
This issue should describe the bug you intend to fix or the feature you would like to add.
Once you have your code ready for review, please open a pull request in the respective repository.
A [committer of the GLSP project](https://projects.eclipse.org/projects/ecd.glsp/who) will then review your contribution and help to get it merged.

Please note that before your pull request can be accepted, you must electronically sign the [Eclipse Contributor Agreement](https://www.eclipse.org/legal/ECA.php).
For more information, see the [Eclipse Foundation Project Handbook](https://www.eclipse.org/projects/handbook/#resources-commit).

### Branch names and commit messages

If you are an [elected committer of the GLSP project](https://projects.eclipse.org/projects/ecd.glsp/who) please create a branch in the respective repository.
Otherwise please fork and create a branch in your fork for the pull request.

The branch name should be in the form `issues/{issue_number}`, e.g. `issues/123`. So please create an issue before creating a pull request.
All branches with this naming schema will be deleted after they are merged.

In the commit message you should also reference the corresponding issue, e.g. using `closes https://github.com/imixs/open-bpmn/issues/241`, thus allowing [auto close of issues](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords).
Please use the absolute URL of the issue instead of just `#241`, as all issues are kept in <https://github.com/imixs/open-bpmn>, whereas the pull requests are opened against the respective repositories.
Using the absolute URL will still allow to correctly reference issues irrespectively where you open the pull request.

Please make sure you read the [guide for a good commit message](https://chris.beams.io/posts/git-commit/).
127 changes: 66 additions & 61 deletions open-bpmn.glsp-client/workspace/test/collaboration-01.bpmn
Original file line number Diff line number Diff line change
@@ -1,63 +1,68 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<bpmn2:definitions xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" exporter="org.openbpmn" exporterVersion="1.0.0" targetNamespace="http://org.openbpmn">
<bpmn2:collaboration id="collaboration_1" name="Default Collaboration">
<bpmn2:participant id="participant_kLKU1Q" name="Default Process" processRef="process_1"/>
<bpmn2:participant id="participant_xxX2og" name="Pool-1" processRef="process_4F9XMQ">
<bpmn2:documentation id="documentation_mj0QyA"/>
</bpmn2:participant>
</bpmn2:collaboration>
<bpmn2:process definitionalCollaborationRef="collaboration_1" id="process_1" name="Default Process" processType="Public">
<bpmn2:documentation id="documentation_Fph1AQ"/>
</bpmn2:process>
<bpmn2:process definitionalCollaborationRef="collaboration_1" id="process_4F9XMQ" name="Process 2" processType="Private">
<bpmn2:startEvent id="event_PACstQ" name="Event-1">
<bpmn2:outgoing>SequenceFlow_MDxg0Q</bpmn2:outgoing>
<bpmn2:documentation id="documentation_ZgUD8Q"/>
</bpmn2:startEvent>
<bpmn2:manualTask id="task_PVTBpQ" name="Task-1">
<bpmn2:incoming>SequenceFlow_MDxg0Q</bpmn2:incoming>
<bpmn2:outgoing>SequenceFlow_qF8gJQ</bpmn2:outgoing>
<bpmn2:documentation id="documentation_wRidBw"/>
</bpmn2:manualTask>
<bpmn2:endEvent id="event_wd0wAQ" name="Event-2">
<bpmn2:incoming>SequenceFlow_qF8gJQ</bpmn2:incoming>
<bpmn2:documentation id="documentation_qWCUVQ"/>
</bpmn2:endEvent>
<bpmn2:sequenceFlow id="SequenceFlow_MDxg0Q" sourceRef="event_PACstQ" targetRef="task_PVTBpQ"/>
<bpmn2:sequenceFlow id="SequenceFlow_qF8gJQ" sourceRef="task_PVTBpQ" targetRef="event_wd0wAQ"/>
</bpmn2:process>
<bpmndi:BPMNDiagram id="BPMNDiagram_1" name="OpenBPMN Diagram">
<bpmndi:BPMNPlane bpmnElement="collaboration_1" id="BPMNPlane_1">
<bpmndi:BPMNShape bpmnElement="participant_xxX2og" id="BPMNShape_AdTG0A">
<dc:Bounds height="161.0" width="510.0" x="65.0" y="63.0"/>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="event_PACstQ" id="BPMNShape_0jOsZQ">
<dc:Bounds height="36.0" width="36.0" x="140.0" y="115.0"/>
<bpmndi:BPMNLabel id="BPMNLabel_qVu7Tg">
<dc:Bounds height="24.0" width="100.0" x="108.0" y="151.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="task_PVTBpQ" id="BPMNShape_YQd0eA">
<dc:Bounds height="50.0" width="110.0" x="258.0" y="108.0"/>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="event_wd0wAQ" id="BPMNShape_50DQ9g">
<dc:Bounds height="36.0" width="36.0" x="453.0" y="115.0"/>
<bpmndi:BPMNLabel id="BPMNLabel_xZsfPw">
<dc:Bounds height="24.0" width="100.0" x="421.0" y="151.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNEdge bpmnElement="SequenceFlow_MDxg0Q" id="BPMNEdge_h9l0AQ">


<di:waypoint x="176.0" y="133.0"/>
<di:waypoint x="258.0" y="133.0"/>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="SequenceFlow_qF8gJQ" id="BPMNEdge_pXglhg">


<di:waypoint x="368.0" y="133.0"/>
<di:waypoint x="453.0" y="133.0"/>
</bpmndi:BPMNEdge>
</bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
<bpmn2:definitions xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:open-bpmn="http://open-bpmn.org/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" exporter="org.openbpmn" exporterVersion="1.0.0" targetNamespace="http://org.openbpmn">
<bpmn2:extensionElements>
<open-bpmn:auto-align/>
</bpmn2:extensionElements>
<bpmn2:collaboration id="collaboration_1" name="Default Collaboration">
<bpmn2:participant id="participant_kLKU1Q" name="Default Process" processRef="process_1"/>
<bpmn2:participant id="participant_xxX2og" name="Pool-1" processRef="process_4F9XMQ">
<bpmn2:documentation id="documentation_mj0QyA"/>
</bpmn2:participant>
</bpmn2:collaboration>
<bpmn2:process definitionalCollaborationRef="collaboration_1" id="process_1" name="Default Process" processType="Public">
<bpmn2:documentation id="documentation_Fph1AQ"/>
</bpmn2:process>
<bpmn2:process definitionalCollaborationRef="collaboration_1" id="process_4F9XMQ" name="Process 2" processType="Private">
<bpmn2:startEvent id="event_PACstQ" name="Event-1">
<bpmn2:outgoing>SequenceFlow_MDxg0Q</bpmn2:outgoing>
<bpmn2:documentation id="documentation_ZgUD8Q"/>
</bpmn2:startEvent>
<bpmn2:manualTask id="task_PVTBpQ" name="Task-1">
<bpmn2:incoming>SequenceFlow_MDxg0Q</bpmn2:incoming>
<bpmn2:outgoing>SequenceFlow_qF8gJQ</bpmn2:outgoing>
<bpmn2:documentation id="documentation_wRidBw"/>
</bpmn2:manualTask>
<bpmn2:endEvent id="event_wd0wAQ" name="Event-2">
<bpmn2:incoming>SequenceFlow_qF8gJQ</bpmn2:incoming>
<bpmn2:documentation id="documentation_qWCUVQ"/>
</bpmn2:endEvent>
<bpmn2:sequenceFlow id="SequenceFlow_MDxg0Q" sourceRef="event_PACstQ" targetRef="task_PVTBpQ">
<bpmn2:documentation id="documentation_qQi0Mg"/>
</bpmn2:sequenceFlow>
<bpmn2:sequenceFlow id="SequenceFlow_qF8gJQ" sourceRef="task_PVTBpQ" targetRef="event_wd0wAQ">
<bpmn2:documentation id="documentation_8DQhEg"/>
</bpmn2:sequenceFlow>
</bpmn2:process>
<bpmndi:BPMNDiagram id="BPMNDiagram_1" name="OpenBPMN Diagram">
<bpmndi:BPMNPlane bpmnElement="collaboration_1" id="BPMNPlane_1">
<bpmndi:BPMNShape bpmnElement="participant_xxX2og" id="BPMNShape_AdTG0A">
<dc:Bounds height="161.0" width="510.0" x="65.0" y="63.0"/>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="event_PACstQ" id="BPMNShape_0jOsZQ">
<dc:Bounds height="36.0" width="36.0" x="136.0" y="115.0"/>
<bpmndi:BPMNLabel id="BPMNLabel_qVu7Tg">
<dc:Bounds height="20.0" width="100.0" x="104.0" y="151.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="task_PVTBpQ" id="BPMNShape_YQd0eA">
<dc:Bounds height="50.0" width="110.0" x="258.0" y="108.0"/>
</bpmndi:BPMNShape>
<bpmndi:BPMNShape bpmnElement="event_wd0wAQ" id="BPMNShape_50DQ9g">
<dc:Bounds height="36.0" width="36.0" x="453.0" y="115.0"/>
<bpmndi:BPMNLabel id="BPMNLabel_xZsfPw">
<dc:Bounds height="20.0" width="100.0" x="421.0" y="151.0"/>
</bpmndi:BPMNLabel>
</bpmndi:BPMNShape>
<bpmndi:BPMNEdge bpmnElement="SequenceFlow_MDxg0Q" id="BPMNEdge_h9l0AQ">
<di:waypoint x="171.54992877478423" y="137.0"/>
<di:waypoint x="217.0" y="137.0"/>
<di:waypoint x="217.0" y="133.0"/>
<di:waypoint x="258.0" y="133.0"/>
</bpmndi:BPMNEdge>
<bpmndi:BPMNEdge bpmnElement="SequenceFlow_qF8gJQ" id="BPMNEdge_pXglhg">
<di:waypoint x="368.0" y="133.0"/>
<di:waypoint x="453.0" y="133.0"/>
</bpmndi:BPMNEdge>
</bpmndi:BPMNPlane>
</bpmndi:BPMNDiagram>
</bpmn2:definitions>

0 comments on commit 56fd53e

Please sign in to comment.