This project welcomes new contributors and invites everyone to participate. Our aim is to build an open community. There are many different ways to get involved:
People that help with the project in any of the above categories or other ways are contributors. See the roles as defined by the ASF. Community members that make sustained, welcome contributions to the project may be invited to become a committer.
Apache JIRA is used for issue tracking. If you do not already have an Apache JIRA account, sign up here. Note that the user name should have no white spaces or other special characters that complicate auto-completion within JIRA comments etc.
Please use a single JIRA account only (don't create multiple with different email addresses) to retain the issue history. Please use a permanent email address, for an existing account it can be changed in the profile. If you absolutely have to change your user name, contact INFRA.
Apex has 2 JIRA projects:
Before working on changes for any of the repositories, please locate an existing JIRA ticket or submit a new one. In order to assign an issue to yourself, you need to be listed as contributor in the JIRA project. PMC members have access to add new contributors, please request to be added through a comment on your candidate ticket or send us an email on the dev@ mailing list.
We use GitHub’s pull request functionality to review proposed code changes. If you do not already have a personal GitHub account, sign up here. We recommend that you use the same email address and first/lastname for emails, git and JIRA so that contributions can be better tracked and notifications correlated. It is also recommended that you use an email address that is valid permanently (for example your @gmail.com or @apache.org address). Please also see:
If you are new to git, this tutorial may be helpful.
The ASF Apex git repositories have mirror repositories on github which are used to review pull requests and provide a second remote endpoint for the codebase.
git clone https://github.com/{github_username}/apex-core.git
git remote add upstream https://github.com/apache/apex-core
For prerequisites and setup instructions see: http://apex.apache.org/docs/apex/apex_development_setup/
Apache Apex follows coding style that is closest to K & R style and uses Checkstyle tool to enforce these standards. Apex checkstyle enforces no trailing whitespace. Travis CI will fail for any pull request that introduces any style violations. The checkstyle configuration is here.
To make it easier for the users to set up their development environment, settings for the following common IDEs are provided in the Apache Apex Core repository with instructions.
master
branch, name it with the JIRA number, e.g. APEXCORE-123.my-feature
:git checkout -b APEXCORE-123.my-feature -t upstream/master
git branch -u upstream/master
mvn license:check -Dlicense.skip=false
to check correct header formatting.mvn license:format -Dlicense.skip=false
to automatically add the header when missing.master
. Use the JIRA number (e.g. APEXCORE-123) as prefix in the pull request title. This will ensure the information is attached to the JIRA ticket automatically.@
notation in Github comments to mention that user, and request that he/she reviews your changes.mvn checkstyle:check -Dcheckstyle.console=true
and correct those issues that were introduced with your changes.If tracking upstream/master then run git rebase -i
. Else run git rebase -i upstream/master
. This command opens the text editor which lists the multiple commits:
pick 67cd79b change1 pick 6f98905 change2 # Rebase e13748b..3463fbf onto e13748b (2 command(s)) # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like "squash", but discard this commit's log message # x, exec = run command (the rest of the line) using shell # # These lines can be re-ordered; they are executed from top to bottom.
Squash ‘change2’ to ‘change1’ and save.
pick 67cd79b change1 squash 6f98905 change2
master
substantially. Therefore, it is recommended to frequently merge master
to the branch being worked on by:git pull
git pull upstream master
master
results in a conflict then resolve it and commit the merge. This results in additional merge commits in the pull request. Following steps help to ensure that the final pull request contains just one commit:git branch -m APEXCORE-123.my-feature.squash
git checkout -b APEXCORE-123.my-feature -t upstream/master
git merge --squash APEXCORE-123.my-feature.squash
git commit -m "APEXCORE-123 #comment added my-feature"
git push origin +APEXCORE-123.my-feature
git branch -D APEXCORE-123.my-feature.squash
Thanks for contributing!
https://git-wip-us.apache.org/repos/asf/apex-core.git
dev@apex.apache.org
mailing list to see the exact commands to merge the given pull request.master
branch. Within a few seconds, the changes will propagate back to the github mirror and the pull requests be closed and marked merged automatically.Fix version
field on the corresponding JIRA ticket needs to be set and the ticket resolved after pushing the changes.Note: since none of us has write access to the mirror, only the author of a pull request can close it if it was not merged.