vieter-v
/
v
2
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: fix CONTRIBUTING.md typos

pull/4403/head
yuyi 2020-04-14 21:13:36 +08:00 committed by GitHub
parent 75603beeea
commit 449575a122
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -5,7 +5,8 @@ possible. One of V's goals is to be open to developers with different levels
of experience in compiler development. Compilers don't need to be black boxes of experience in compiler development. Compilers don't need to be black boxes
full of magic that only few people understand. full of magic that only few people understand.
The V compiler is modular, and can by used by other applications. It is located in `cmd/v/` and `vlib/v/`. The V compiler is modular, and can be used by other applications. It is located
in `cmd/v/` and `vlib/v/`.
The main files are: The main files are:
@ -69,17 +70,17 @@ NB: the remote named `pullrequest` should point to YOUR own forked repo, not the
After this, your local cloned repository is prepared for making pullrequests, After this, your local cloned repository is prepared for making pullrequests,
and you can just do normal git operations such as: `git pull` `git status` and so on. and you can just do normal git operations such as: `git pull` `git status` and so on.
1. When finished with a feature/bugfix/change, you can: 5. When finished with a feature/bugfix/change, you can:
`git checkout -b fix_alabala` `git checkout -b fix_alabala`
2. `git push pullrequest` # (NOTE: the `pullrequest` remote was setup on step 4) 6. `git push pullrequest` # (NOTE: the `pullrequest` remote was setup on step 4)
3. On GitHub's web interface, go to: https://github.com/vlang/v/pulls 7. On GitHub's web interface, go to: https://github.com/vlang/v/pulls
Here the UI shows a dialog with a button to make a new pull request based on Here the UI shows a dialog with a button to make a new pull request based on
the new pushed branch. the new pushed branch.
(Example dialog: https://url4e.com/gyazo/images/364edc04.png) (Example dialog: https://url4e.com/gyazo/images/364edc04.png)
4. After making your pullrequest (aka, PR), you can continue to work on the 8. After making your pullrequest (aka, PR), you can continue to work on the
branch `fix_alabala` ... just do again `git push pullrequest` when you have more commits. branch `fix_alabala` ... just do again `git push pullrequest` when you have more commits.
5. If there are merge conflicts, or a branch lags too much behind V's master, 9. If there are merge conflicts, or a branch lags too much behind V's master,
you can do the following: you can do the following:
1. `git pull --rebase origin master` # solve conflicts and do `git rebase --continue` 1. `git pull --rebase origin master` # solve conflicts and do `git rebase --continue`
2. `git push pullrequest -f` # this will overwrite your current remote branch with the updated version of your changes. 2. `git push pullrequest -f` # this will overwrite your current remote branch with the updated version of your changes.