First email to the dev mailing list (example)
Subject: I want to contribute to Apache ignite
My name is [ Name ]. I want to contribute to Ignite. I would like to start from [ identification of particular ticket or module, if you have one in mind ]. Please, help me to start contributing.
My ASF JIRA username is [ username ]*.
[ Name ]
*learn more about ASF JIRA below
If you do not have ASF JIRA account, use https://selfserve.apache.org/jira-account.html to request a new one before going to the next step.
Once you have an ASF JIRA account, send out an introduction email to the project's dev mailing list (at first: subscribe) with a request for contributors permissions. PMCs should handle this request and grant contributor access to a new community member.
The JIRA handling process outlined below should be followed in absolutely all cases, without exceptions, regardless of the ticket complexity.
Tickets are picked up by community members from a pool of unassigned and unscheduled tickets.
JIRA issues are grouped by
fixVersion field. Tickets should be assigned to an unreleased version if they are blockers or regressions for that version. The contributor should make sure that
fixVersion is set to a proper version that actually releases the changes made in the scope of the ticket. Open and in-progress tickets may have this field blank.
The following page contains information on upcoming releases: Release Planning.
If the changes implemented under the ticket require changes in user documentation, create a related documentation ticket (add "Documentation" to the Component field) and provide a reasonable amount of details in the ticket's description. The information provided in the ticket should be sufficient for any contributor to start working on it. If there is no need to change user documentation, uncheck the Docs Required flag. The Docs Required flag is used to filter out the tickets that require documentation so that our documentation is always up to date.
Any change should be reviewed by a contributor and passed to a committer (who may or may not be the same as the main reviewer) for merging.
Optional: Tips to pass review quickly
Check affected files' git history to find a person most likely able to review changes.
In case it's hard to determine who's able to review by git history use maintainers list presented below.
Add "review request" comment to the Jira Issue starting with a contributor username.
for example: "[~avinogradov], Please review my changes."
This user will be notified and will review your changes and/or help to find another contributor to do a review, then will help you finding a committer to merge the change if needed.
You will need to update a local master sometimes (to merge to your development branches sometimes). How to do it:
Add remote for Apache Ignite mirror (you need to do it once)
git remote add upstream https://github.com/apache/ignite
Each time when you want to update your local master do the following:
In addition to contributors configuration, committers need to have one more remote repo - for working with Apache Git repo. It can be added like this:
git remote add apache https://gitbox.apache.org/repos/asf/ignite.git
To push any branch at Apache repo use
git push apache <branch_name>
To apply a pull-request it's strongly recommended using ./scripts/apply-pull-request.sh script. Script takes 'pull-request-id' as a parameter and do next:
git fetch upstream pull/<id>/head:pull-<id>-head
git merge --squash pull-<id>-head
git commit --author=“<saved_author>" -s -m “<comment> - Fixes #<id>.”
Now, you will have one commit at master with all changes from the pull-request. Changes can be reviewed again. If you accept all changes and want to push it, do next:
git push apache master
Whenever working on bigger features, committers can also create 'ready to be reviewed' branch ignite-XXXX, where XXXX is the number of the JIRA ticket.
TeamCity should be forced to run all tests on created branch before review. Once tests are passed, the branch has been reviewed by the module's maintainer.
Created branch name should be attached to a JIRA ticket and the ticket status should be changed on Patch Available.
The branch can be merged to master on successful review by at least one another committer.
The branch should be deleted on branch merged to master or issue canceled. Committers are in charge of deleting their branches.
|Ignite Core (the rest of internals not covered below)|
|Marshalling (Binary, Optimized, JDK)|
|Discovery & Communication SPIs|
|Ignite Compute API|
|Ignite Services API|
|Ignite SQL & Text Queries & JDBC|
|Ignite Continuous Queries|
|Machine Learning/Deep Learning (ml, TensorFlow, sub-modules in ml)|
|Build System / Releases|
|Other thin clients (Python, Node.js, PHP, etc)|
|Streamers (JMS, Flume, Kafka, etc.)|
|Docker, Mesos, YARN integration|
|AWS, Google Compute Engine, JClouds integration|
|WebSession & WebSession Filter|