同步操作将从 Gitee 极速下载/camunda-bpm-platform 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
We would love you to contribute to this project. You can do so in various ways.
Help others by participating in our forum. Please read the Forum FAQ before you start.
File bugs you found in the code or features you would like to see in the future in our JIRA project named CAM.
You can contribute code that fixes bugs and/or implements features. Here is how it works:
In order to build our codebase from source, add the following to your Maven settings.xml
.
<profiles>
<profile>
<id>camunda-bpm</id>
<repositories>
<repository>
<id>camunda-bpm-nexus</id>
<name>camunda-bpm-nexus</name>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
<url>https://app.camunda.com/nexus/content/groups/public</url>
</repository>
</repositories>
</profile>
</profiles>
<activeProfiles>
<activeProfile>camunda-bpm</activeProfile>
</activeProfiles>
An entire repository can then be built by running mvn clean install
in the root directory. This will build all sub modules and execute unit tests. Furthermore, you can restrict the build to just the module you are changing by running the same command in the corresponding directory. Check the repository's or module's README for additional module-specific instructions. The webapps
and swagger-ui
modules requires NodeJS. You can exclude building them by running mvn clean install -pl '!webapps,!org.camunda.bpm.run:camunda-bpm-run-modules-swaggerui'
.
Integration tests (e.g. tests that run in an actual application server) are usually not part of the default Maven profiles. If you think they are relevant to your contribution, please ask us in the ticket, on the forum or in your pull request for how to run them. Smaller contributions usually do not need this.
In order to show us your code, you can create a pull request on Github. Do this when your contribution is ready for review, or if you have started with your implementation and want some feedback before you continue. It is always easier to help if we can see your work in progress.
A pull request can be submitted as follows:
master
. This should also be the default in the Github UI.Before submitting your pull request for code review, please go through the following checklist:
Before we can merge your contribution you have to sign our Contributor License Agreement (CLA). The CLA contains the terms and conditions under which the contribution is submitted. You need to do this only once for your first pull request. Keep in mind that without a signed CLA we cannot merge your contribution.
The messages of all commits must conform to the style:
<type>(<scope>): <subject>
<body>
<footer>
Example:
feat(engine): Support BPEL
- implements execution for a really old standard
- BPEL models are mapped to internal ActivityBehavior classes
related to CAM-1337
Have a look at the commit history for real-life examples.
One of the following:
The scope is the module that is changed by the commit. E.g. engine
in the case of https://github.com/camunda/camunda-bpm-platform/tree/master/engine.
A brief summary of the change. Use imperative form (e.g. implement instead of implemented). The entire subject line shall not exceed 70 characters.
A list of bullet points giving a high-level overview of the contribution, e.g. which strategy was used for implementing the feature. Use present tense here (e.g. implements instead of implemented). A line in the body shall not exceed 80 characters. For small changes, the body can be omitted.
Must be related to <ticket>
where ticket is the ticket number, e.g. CAM-1234. If the change is related to multiple tickets, list them in a comma-separated list such as related to CAM-1234, CAM-4321
.
Every source file in an open-source repository needs to contain the following license header at the top, formatted as a code comment:
Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
under one or more contributor license agreements. See the NOTICE file
distributed with this work for additional information regarding copyright
ownership. Camunda licenses this file to you under the Apache License,
Version 2.0; you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
The header can be added manually (check other files). If you use our IDE settings, it will be generated automatically when you create new .java
files. You can also add it by running mvn clean install -Plicense-header-check
in the module that you have changed. This command also re-formats any incorrectly formatted license header.
Contributions that do not contain valid license headers cannot be merged.
We usually check for new community-submitted pull requests once a week. We will then assign a reviewer from our development team and that person will provide feedback as soon as possible.
Note that due to other responsibilities (our own implementation tasks, releases), feedback can sometimes be a bit delayed. Especially for larger contributions, it can take a bit until we have the time to assess your code properly.
During review we will provide you with feedback and help to get your contribution merge-ready. However, before requesting a review, please go through our contribution checklist.
Once your code is merged, it will be shipped in the next alpha and minor releases. We usually build alpha releases once a month and minor releases once every six months. If you are curious about the exact next minor release date, check our release announcements page.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。