...
An important part of the process comes before you start the contribution process. Most issues should first be brought up in thethe dev@reef.incubator.apache.org mailing list. If you haven't done so yet, subscribe to the list by sending a message to dev-subscribe@reef.incubator.apache.org. After discussion, you or one of the developers will create an Issue on ASF JIRA. Again, create an account if you don't have one. Write a succinct description of the Issue, making sure to incorporate any discussion from the mailing list.
...
First, you need to fork the REEF repository. Go to the Github repository (https://github.com/apache/incubator-reef) mirrored mirrored from ASF, and click `Fork` "Fork" button. Then you will have your own repository. Clone this repository to your local machine:
...
Then, add the apache GitHub repository as `upstream`upstream:
| Code Block | ||
|---|---|---|
| ||
$ git remote add upstream https://github.com/apache/incubator-reef |
...
If you have an `apache.org` email address, now is the time to [configure git](https://git-wip-us.apache.org/) to to use it:
| Code Block | ||
|---|---|---|
| ||
$ git config user.name "My Name Here" $ git config user.email myusername@apache.org |
...
Before making changes, you have to make sure the issue to resolve (e.g. fix a bug, implement a new feature, etc) is registered in the [REEF JIRA](https://issues.apache. org/jira/browse/REEF). Create a branch to address the issue on your own. The name of the branch should reference the issue, e.g., `REEF REEF-{issue_number}`. You can take a look how others name their branches.
3. Make changes in your local machine
Write the code and make commits as usual. Make sure all new files contain the [ASF header](https://github.com/apache/incubator-reef/blob/master/LICENSE_HEADER.txt).
4. Merge the master branch into your branch
...
It is time to send a pull request. If you do not know much about pull request, you may want to read this [`article`](https://help.github.com/articles/using-pull-requests/). article.
If you go to the repository at the Github website, you can notice that `Compare "Compare & Pull request` request" button appears. Click the button or move into `pull request` "pull request" tab if you cannot find the button.
When you create a pull request, you choose the branches to compare and merge. Choose the base as `as apache:master` and and the head `head {your_alias}:{branch_name}`. Fill out the description with what you have done. It is a good practice to start the description with `This "This addresses https://issues.apache.org/jira/browse/REEF-{issue_number}`"
You can push additional commits to address the feedback from the reviewer. When the status is good enough to be merged in the master branch, one of Committers will merge your work into the REEF codebase. Good job!
...
If you are committer, you can follow the steps in the [Committer Guide](https://cwiki.apache.org/confluence/display/REEF/Committer+Guide) to to merge the pull request. Of course, you won't be merging your own pull requests. Nudge committers as needed to make sure everything gets merged correctly.
...