Table of Contents

First things first: Welcome!

...

If you want to work on the REEF code base, it is a good idea to learn how to compile and test REEF. 

Finding things to work on

At any given time, there is any number of open, unassigned issues on REEF. There is also a shorter list of open issues which are good for beginners. Note that that list doesn't only contain coding tasks, but also documentation, graphics work, the website and so on. We use JIRA to manage all open todos for the project, software or otherwise. However, some of the items on that list might since have become obsolete or such. Hence, it is always a good idea to get in touch with the rest of the community on the mailing list before getting started.

Code contribution process

...

$ git remote add upstream https://github.com/apache/reef.git

A correct git configuration should look similar to the following, with an origin and upstream:

...

[REEF-JIRA_ISSUE_NUMBER] THE_TITLE_OF_THE_JIRA
 
This addressed the issue by 
  * INSERT_DESCRIPTION_OF_SOMETHING
  * INSERT_DESCRIPTION_OF_SOMETHING_ELSE
  * ...
 
JIRA:
  [REEF-JIRA_ISSUE_NUMBER](https://issues.apache.org/jira/browse/REEF-JIRA_ISSUE_NUMBER)

Pull request:
  This closes #

As you can see, we follow Markdown syntax for our commit messages. You can get a good idea how other people write their commit messages by inspecting the output of git log.

...