Versions Compared

Old Version 24

changes.mady.by.user Zuyu Zhang

Saved on

compared with

New Version 25

changes.mady.by.user Zuyu Zhang

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Goal

  • Keep a serialized, linear history of the master branch in the ASF repo.
  • Each commit would have a dedicate JIRA ticket, unless the change is trivial.

Fork the ASF repo

  1. git clone https://git-wip-us.apache.org/repos/asf/incubator-quickstep.git quickstep
  2. cd quickstep

NOTE

Always use "git rebase". Never use "git pull" or "git merge" as that changes the master history, and will produce unrelated commit messages for future PRs. 

Work on a new feature

  1. Create a JIRA ticket at https://issues.apache.org/jira/browse/QUICKSTEP. Let's assume the JIRA ticket is identified as: QUICKSTEP-101.
  2. git checkout master
  3. git checkout -b myquickstep-awesome-feature101
  4. git add some-changed-or-new-files
  5. Then test your changes doing at least the following:

    • Check if your code confirms to the code guidelines by running the following command from the root of the quickstep source directory: python third_party/cpplint/lint_everything.py

    • Check for CMake validation errors by running the following command from the root of the quickstep source directory: python validate_cmakelists.py
    • Check for cyclic dependencies by running the following command from the root of the quickstep source directory: python cyclic_dependency.py
    • From the build directory, run all the tests using the command: ctesttest -j8
  6. git commit -m "QUICKSTEP-101: Add Added My Awesome Feature."
  7. git push origin myquickstep-awesome-feature101

Sometimes, there may be code review comments after a PR has been opened. Address these comments and then do the following: 

  1. git add more-changed-or-new-files
  2. git commit -m "Addressed Review Comments."

Finally, once the PR is ready to be merged (i.e. it has passed all the tests and the python validation scripts as described above), we need to squash all the commits into one commit. We cherry pick the first commit, and squash all the rest as follows:

  1. git rebase -i origin/master
  2. In the editor, you should see something like: 
    pick QUICKSTEP-101: Add Added My Awesome Feature.
    pick Addressed Review Comments.
  3. While still in the editor, modify the second line to the following.
    s Addressed Review Comments.
  4. While still in the editor, modify the squashed commit messages if needed.
  5. Check the git log using: git log.
  6. Check the "Author" field in the last commit with the intended name and email. Amend if needed.
  7. Now you are ready to push the code. You can do that using: git push origin myquickstep-awesome-feature 101 -f

Create a Pull Request (PR) for the new feature

Use the GitHub ASF mirror repo: https://github.com/apache/incubator-quickstep, and set the title for the PR to match the title of the JIRA ticket.

In this case, QUICKSTEP-101: Add Added My Awesome Feature.

Merge a PR

To merge a PR, go through the following steps: 

  1. Update the local fork with the new branch my-awesome-featurebranch quickstep-101.
    1. If the new branch is in the ASF repo, do git fetch origin
    2. Otherwise, we need to fetch from a remote fork repo.
      git remote add some-contributor https://github.com/some-contributor/incubator-quickstep.git
      git remote -v
      git fetch some-contributor
  2. git checkout master
  3. Ensure that the PR is one commit with a well-written commit message.
  4. Rebase the PR with the origin master branch in the ASF repo.
    1. If the new branch is in the ASF repo, git rebase -i origin/myquickstep-awesome-feature101
    2. Otherwise, git rebase -i some-contributor/myquickstep-awesome-feature101
      Now if we see "noop", we are good to merge. Otherwise, the committer should notify the PR submitter to rebase the branch to make it a single commit ahead the current master branch.
  5. git log
    If we see a commit message like "Merge branch 'master' of https://git-wip-us.apache.org/repos/asf/incubator-quickstep", we should abort the merge; otherwise we will mess up the master history.
  6. git push origin master
    This command triggers asfgit to merge the PR in GitHub ASF mirror repo. 
  7. Delete the branch if it is in the ASF repo.
    git push origin --delete myquickstep-awesome-feature101
    This command triggers asfgit to delete the merged branch. 
  8. Close the JIRA ticket regarding this PR by visiting: https://issues.apache.org/jira/browse/QUICKSTEP