diff options
| author | Julia Hansbrough <flowerhack@google.com> | 2018-08-16 18:29:17 -0700 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2018-08-17 06:57:27 -0700 |
| commit | f22e81b50080de7c5ea503f1cead16ed85a16f79 (patch) | |
| tree | 89d3b990304cf3a7e032681d5fae0e2a28a2bc5d /docs | |
| parent | 9ccc1d4565436890480aea12b6ae347384b2d1ab (diff) | |
[doc] Update contributing instructions.
Details how to run tests and how to work around gofmt bug.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index c0871c692..0c95c0729 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -49,6 +49,17 @@ This adds git origin `my-origin` with your repository and checks out new 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. +- Run tests locally (`make install_prerequisites` followed by `make presubmit`). +- *Important* If you've run `go fmt` and you're seeing the presubmit fail on + `check_diff`, then you may need to use an older version of go to format your + code. (Version 1.11 in particular introduced a breaking change, see + [here](https://github.com/golang/go/issues/25161) and + [here](https://github.com/golang/go/issues/26228) for details). A + simple way to do this is: + ```go get golang.org/dl/go1.10 + go1.10 download + # Default download path is here. + ~/sdk/go1.10/bin/go fmt [target files]``` - 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-branch` as compare and press `Create pull request`. |