github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-24 14:33:38 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #14 from dbkinder/contrib1

Browse Source 
doc: fix formatting errors in contribution guide
This commit is contained in:
David Kinder 2018-03-08 22:37:50 -08:00 committed by GitHub
commit b4b3ebcb9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 52 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
contribute.rst
View File

@ -214,7 +214,7 @@ workflow here:
#. On your development computer, clone the fork you just made:: #. On your development computer, clone the fork you just made::
git clone https://github.com/<your github id>/acrn-hypervisor git clone https://github.com/<your github id>/acrn-hypervisor
This would be a good time to let Git know about the upstream repo too:: This would be a good time to let Git know about the upstream repo too::
@ -254,67 +254,63 @@ workflow here:
agreement with the `DCO`_. See the `Commit Guidelines`_ section agreement with the `DCO`_. See the `Commit Guidelines`_ section
below for specific guidelines for writing your commit messages. below for specific guidelines for writing your commit messages.
#. Push your topic branch with your changes to your fork in your personal #. Push your topic branch with your changes to your fork in your personal
GitHub account: GitHub account::
git push origin fix_comment_typo git push origin fix_comment_typo
#. In your web browser, go to your forked repo and click on the Compare & pull #. In your web browser, go to your forked repo and click on the Compare & pull
request button for the branch you just worked on and you want to open a pull request button for the branch you just worked on and you want to open a pull
request with. request with.
#. Review the pull request changes, and verify that you are opening a pull request #. Review the pull request changes, and verify that you are opening a pull request
for the appropriate branch. The title and message from your commit message should for the appropriate branch. The title and message from your commit message should
appear as well. appear as well.
#. If you’re working on a subsystem branch that’s not master, you may need to change #. GitHub will assign one or more suggested reviewers (based on the CODEOWNERS file
the intended branch for the pull request here, for example, by changing the base in the repo). If you are a project member, you can select additional reviewers
branch from master to net. now too.
#. GitHub will assign one or more suggested reviewers (based on the CODEOWNERS file #. Click on the submit button and your pull request is sent and awaits review.
in the repo). If you are a project member, you can select additional reviewers Email will be sent as review comments are made, or you can check on your
now too. pull request at https://github.com/projectacrn/acrn-hypervisor/pulls.
#. Click on the submit button and your pull request is sent and awaits review. #. While you’re waiting for your pull request to be accepted and merged, you can
Email will be sent as review comments are made, or you can check on your create another branch to work on another issue. (Be sure to make your new branch
pull request at https://github.com/projectacrn/acrn-hypervisor/pulls. off of master and not the previous branch.)::
#. While you’re waiting for your pull request to be accepted and merged, you can git checkout master
create another branch to work on another issue. (Be sure to make your new branch git checkout -b fix_another_issue
off of master and not the previous branch.):
and use the same process described above to work on this new topic branch.
#. If reviewers do request changes to your patch, you can interactively rebase
commit(s) to fix review issues. In your development repo::
git fetch --all
git rebase --ignore-whitespace upstream/master
The ``--ignore-whitespace`` option stops git apply (called by rebase) from changing
any whitespace. Continuing::
git rebase -i <offending-commit-id>
In the interactive rebase editor, replace pick with edit to select a specific
commit (if there’s more than one in your pull request), or remove the line to
delete a commit entirely. Then edit files to fix the issues in the review.
As before, inspect and test your changes. When ready, continue the
patch submission::
git checkout master
git checkout -b fix_another_issue
and use the same process described above to work on this new topic branch.
#. If reviewers do request changes to your patch, you can interactively rebase
commit(s) to fix review issues. In your development repo:
git fetch --all
git rebase --ignore-whitespace upstream/master
The --ignore-whitespace option stops git apply (called by rebase) from changing
any whitespace. Continuing:
git rebase -i <offending-commit-id>
In the interactive rebase editor, replace pick with edit to select a specific
commit (if there’s more than one in your pull request), or remove the line to
delete a commit entirely. Then edit files to fix the issues in the review.
As before, inspect and test your changes. When ready, continue the patch submission:
git add [file(s)] git add [file(s)]
git rebase --continue git rebase --continue
Update commit comment if needed, and continue: Update commit comment if needed, and continue::
git push --force origin fix_comment_typo
By force pushing your update, your original pull request will be updated with
your changes so you won’t need to resubmit the pull request.
git push --force origin fix_comment_typo
By force pushing your update, your original pull request will be updated with
your changes so you won’t need to resubmit the pull request.
Commit Guidelines Commit Guidelines