From ef579626347554b4b153eec2f9e58a3f500587e5 Mon Sep 17 00:00:00 2001 From: Andrey Konovalov Date: Tue, 7 Nov 2017 14:23:57 +0100 Subject: Update contributing.md --- docs/contributing.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'docs/contributing.md') diff --git a/docs/contributing.md b/docs/contributing.md index b16e60ca9..c0871c692 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -40,15 +40,16 @@ so that there is agreement on high level approach and no duplication of work bet ```shell cd $GOPATH/src/github.com/google/syzkaller -git remote add my https://github.com/YOUR_GITHUB_USERNAME/syzkaller.git -git fetch my -git checkout -b my-changes master +git remote add my-origin https://github.com/YOUR_GITHUB_USERNAME/syzkaller.git +git fetch my-origin +git checkout -b my-branch master ``` -This adds git origin `my` with your repository and checks out new branch `my-changes` based on `master` branch. +This adds git origin `my-origin` with your repository and checks out new branch `my-branch` based on `master` branch. - Change/add files as necessary. - Commit changes locally. For this you need to run `git add` for all changed files, e.g. `git add sys/linux/sys.txt`. You can run `git status` to see what files were changed/created. When all files are added (`git status` shows no files in `Changes not staged for commit` section and no relevant files in `Untracked files` section), run `git commit` and enter commit description in your editor. -- Push the commit to your fork on github with `git push --set-upstream my my-changes`. +- Push the commit to your fork on github with `git push my-origin my-branch`. - Nagivate to [github.com/google/syzkaller](https://github.com/google/syzkaller) and you should see green `Compare & pull request` button, press it. Then press `Create pull request`. Now your pull request should show up on [pull requests page](https://github.com/google/syzkaller/pulls). -- If you don't see `Create pull request` button for any reason, you can create pull request manually. For that nagivate to [pull requests page](https://github.com/google/syzkaller/pulls), press `New pull request`, then `compare across forks` and choose `google/syzkaller`/`master` as base and `YOUR_GITHUB_USERNAME/syzkaller`/`my-changes` as compare and press `Create pull request`. +- If you don't see `Create pull request` button for any reason, you can create pull request manually. For that nagivate to [pull requests page](https://github.com/google/syzkaller/pulls), press `New pull request`, then `compare across forks` and choose `google/syzkaller`/`master` as base and `YOUR_GITHUB_USERNAME/syzkaller`/`my-branch` as compare and press `Create pull request`. +- If you decided to rebase commits in `my-branch` (e.g. to rebase them onto updated master) after you created a pull-request, you will need to do a force push: `git push -f my-origin my-branch`. -- cgit mrf-deployment