status-im
/
status-go
mirror of https://github.com/status-im/status-go.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Common instructions how to merge PRs and keep history clean (#791)

This commit is contained in:
Dmitry Shulyak 2018-04-04 13:41:45 +03:00 committed by GitHub
parent 5e5e497822
commit aa4966ce11
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.github/CONTRIBUTING.md vendored
View File

@ -27,3 +27,12 @@ You can also discover more information in https://hackmd.io/s/SkZI0bXIb
Please, note that we follow [Effective Go](https://golang.org/doc/effective_go.html) and
[CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments) in our code.
## Keep history clean
1. Squash PR before merging.
You can do it either with GitHub API by merging with "Squash and merge" or locally if you want to preserve your signature.
It is ok to merge multiple commits with "Rebase and merge" if they are logically separate.
2. Preserve as much history as possible.
If you need to re-name file use `git mv` - it will preserve git history.

1
README.md
View File

@ -7,6 +7,7 @@
- [How To Build](https://wiki.status.im/Building_status-go)
- [Notes on Bindings](https://wiki.status.im/Status-go_Binding_notes)
- [How To Contribute](.github/CONTRIBUTING.md)
# Intro