Apache Mnemonic

Submit Changes

After Development Setup, you can follow the steps below to submit your code/comments and document changes.

  • Step 1 - Sync your forked Mnemonic project from upstream. Show Me How

    Please keep the master branch untouched, otherwise we can’t keep it exactly synced.

bash $ git fetch upstream $ git checkout master $ git merge upstream/master $ git push

  • Step 2 - Take over an interested issue/task by clicking the “Start Progress” button in the Apache issue web portal. Project Issue Portal

  • Step 3 - Create a new branch for your selected issue/task.

bash $ git checkout master $ git checkout -b issue-[issue id]

  • Step 4 - Apply patch files if any.

bash $ git apply [patch file]

  • Step 5 - Fix/implement the selected issue/task on the specific branch.Please ensure you are working on the create branch, e.g. issue-548, using the following command to confirm it

bash $ git status

  • Step 6 - Stage your new code or code changes before stopping work on it.

bash $ git add [your changed/new files]

  • Step 7 - Rebase your local works from upstream if it takes a long time. Commit your bugfix or feature code once the issue/task got addressed. Stage all your changed/new files first, please refer to step 6 above. If any conflict occurred, please refer to the following way to resolve it.

bash $ git commit -s -m “MNEMONIC-[issue id]: [issue description]” $ git rebase upstream/master

  • Step 8 - Verify your code changes again

bash $ git diff HEAD^…

  • Step 9 - Push your new branch and commit to your own github repo.

bash $ git push --set-upstream origin issue-XXX

  • Step 10 - Submit a PR. Visit the Mnemonic repo. in your own Github account, you can see a message about the new/changed branch, you can submit the PR via click the link in the message. Show Me How

  • Step 11 - Once PR got submitted, Please click “Resolve Issue” button in Apache issue web portal..

  • Step 12 - Normally, wait for 2-5 calendar days for reviewers to take comments on the PR. Address all comments as possible. Once the PR got verified by reviewers, Please click “Close Issue” button in Apache issue web portal.