Code Contributor Workflow

This workflow should be followed by all people that wish to contribute code to Apache Daffodil. There are other types of contributors (e.g. wiki, mailing list support, testing) that this does not cover.

Search for an issue in JIRA that represents the change you would like to make or bug to fix. If one does not exist, create a issue. See How To Report a Bug for creating issues and what information/discussions should take place in JIRA.
Assign the issue to your self. You may need to request permissions to modify the bug by sending an email to dev@daffodil.apache.org
Create a GitHub fork of the Daffodil GitHub mirror and clone it. This remote will be your origin remote:
```
$ git clone git@github.com:username/daffodil.git
$ cd daffodil
```

Add the ASF upstream repository as a new git remote, calling it asf:

$ git remote add asf git://git.apache.org/incubator-daffodil.git
$ git fetch asf

Create a new branch off of the asf/master branch named daffodil-XYZ-description, where XYZ is the JIRA bug number and -description is an optional, very short description of the bug making it easier to differentiate between multiple development branches. For example:
```
$ git checkout -b daffodil-123-bitorder-feature asf/master
```
Make changes to the branch, frequently adding new commits. Code changes should follow the Daffodil Code Style Guidelines and should add appropriate tests using the Test Data Markup Language (TDML) or unit tests. Tests in src/test/scala-debug that are fixed should be moved into src/test/scala.
When changes are complete, rebase your commits onto asf/master and verify that all tests pass:
```
$ git fetch asf
$ git rebase asf/master
$ sbt test
```
Note that you should not use git pull or git merge to sync to the asf repo. Always fetch/rebase and avoid merge commits. Pull requests containing merge commits will be rejected.
If multiple commits were made, git rebase -i asf/master should be used to interactively rebase and squash the commits into the smallest number of logical commits. Most commonly this should be a single commit, but there may be some rare cases where multiple commits make sense.
Ensure each commit has an appropriate and descriptive commit message. The first line of a commit message should contain a short (~50 characters) description of the commit. The second line should be blank, followed by a longer description of the change, wrapped at 72 characters. This long description should describe what was changed in the commit and, more importantly, why those changes were made. The 'what' can be determined by inspecting the code, but the 'why' is often less obvious. At the end of the commit should be a blank line followed by a reference to the JIRA bug, e.g. DAFFODIL-123. Multiple bugs referenced in a single commit should be separated by a comma on the same line. An example of a commit message is:
```
Add support for the dfdl:bitOrder feature
 
Longer explanation of what changes were made to support the bitOrder
feature, including a description of why the changes were made. Multiple
lines are wrapped at 72 characters
 
DAFFODIL-123
```

Push your branch to your fork:

$ git push origin daffodil-123-bitorder-feature

Use the GitHub interface to create a pull request for your new branch.
Mark the JIRA bug as Patch Available.
Wait for review comments. There must be at least two +1's from other committers before the change can be merged. If there are any review comments that require changes or the automated Travis CI build fails, create new a new commit on your branch (do not squash your changes yet or use git ommit --amend) and push your branch to GitHub for furthur review. The pull request will automatically update with your new commit. Continue this process until at least two +1's are recieved from comitters.
Once at least two +1's are received from committers, a committer can accept the pull request. If you made extra commits in step 12, you should now now squash them using git rebase -i and push to origin using the --force option:
```
$ git rebase -i asf/master
$ git push --force origin daffodil-123-bitorder-feature
```
A committer can now merge the pull request using the GitHub gui. This is to be done clicking the "Merge pull request" dropdown and selecting "Rebase and merge". The "Create merge commit" and "Squash and merge" options should not be used.
Mark the JIRA bug as Resolved.
If you would like to clean up, you can now delete your development branch, either via the GitHub user interface or:
```
$ git push --delete origin daffodil-123-bitorder-feature
$ git branch -D daffodil-123-bitorder-feature
```

Page tree

Code Contributor Workflow