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 the Daffodil Issue Tracker information 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 email@example.com
Visit the Apache Daffodil GitHub and create a fork by clicking on "Fork" in the top right.
Clone your new fork. This will be your
Add the ASF upstream repository as a new git remote, calling it asf:
Create a new branch off of the
XYZis the JIRA bug number and
-descriptionis an optional, very short description of the bug making it easier to differentiate between multiple development branches. For example:
- 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-debugthat are fixed should be moved into
When changes are complete, rebase your commits onto
asf/masterand verify that all tests pass:
Note that you should not use
git mergeto sync to the
fetch/rebaseand avoid merge commits. Pull requests containing merge commits will be rejected.
If multiple commits were made,
git rebase -i asf/mastershould 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:
Push your branch to your fork:
- Use the GitHub interface to create a pull request for your new branch.
- 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 a new commit on your branch (do not squash your changes yet or use
git commit --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 fetch the latest asf, rebase and squash the changes into a single commit (fixing potential conflicts), and push to
A committer can now merge the pull request using the GitHub GUI. This is to be done clicking the
"Merge pull request"drop down and selecting
"Rebase and merge". The
"Create merge commit"and
"Squash and merge"options should not be used. For new committers, you may need to link your GitHub and ASF accounts by visiting https://gitbox.apache.org before you can merge.
- Mark the JIRA bug as "
Resolved"and add a comment with the hash that includes the fix.
If you would like to clean up, you can now delete your development branch, either via the GitHub user interface or: