You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

163 lines
6.9 KiB

7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
  1. # Contributing
  2. Thank you for considering making contributions to Tendermint and related repositories! Start by taking a look at the [coding repo](https://github.com/tendermint/coding) for overall information on repository workflow and standards.
  3. Please follow standard github best practices: fork the repo, branch from the tip of develop, make some commits, and submit a pull request to develop. See the [open issues](https://github.com/tendermint/tendermint/issues) for things we need help with!
  4. Please make sure to use `gofmt` before every commit - the easiest way to do this is have your editor run it for you upon saving a file.
  5. ## Forking
  6. Please note that Go requires code to live under absolute paths, which complicates forking.
  7. While my fork lives at `https://github.com/ebuchman/tendermint`,
  8. the code should never exist at `$GOPATH/src/github.com/ebuchman/tendermint`.
  9. Instead, we use `git remote` to add the fork as a new remote for the original repo,
  10. `$GOPATH/src/github.com/tendermint/tendermint `, and do all the work there.
  11. For instance, to create a fork and work on a branch of it, I would:
  12. * Create the fork on github, using the fork button.
  13. * Go to the original repo checked out locally (i.e. `$GOPATH/src/github.com/tendermint/tendermint`)
  14. * `git remote rename origin upstream`
  15. * `git remote add origin git@github.com:ebuchman/basecoin.git`
  16. Now `origin` refers to my fork and `upstream` refers to the tendermint version.
  17. So I can `git push -u origin master` to update my fork, and make pull requests to tendermint from there.
  18. Of course, replace `ebuchman` with your git handle.
  19. To pull in updates from the origin repo, run
  20. * `git fetch upstream`
  21. * `git rebase upstream/master` (or whatever branch you want)
  22. Please don't make Pull Requests to `master`.
  23. ## Dependencies
  24. We use [dep](https://github.com/golang/dep) to manage dependencies.
  25. That said, the master branch of every Tendermint repository should just build
  26. with `go get`, which means they should be kept up-to-date with their
  27. dependencies so we can get away with telling people they can just `go get` our
  28. software.
  29. Since some dependencies are not under our control, a third party may break our
  30. build, in which case we can fall back on `dep ensure` (or `make
  31. get_vendor_deps`). Even for dependencies under our control, dep helps us to
  32. keep multiple repos in sync as they evolve. Anything with an executable, such
  33. as apps, tools, and the core, should use dep.
  34. Run `dep status` to get a list of vendor dependencies that may not be
  35. up-to-date.
  36. When updating dependencies, please only update the particular dependencies you
  37. need. Instead of running `dep ensure -update`, which will update anything,
  38. specify exactly the dependency you want to update, eg.
  39. `dep ensure -update github.com/tendermint/go-amino`.
  40. ## Vagrant
  41. If you are a [Vagrant](https://www.vagrantup.com/) user, you can get started
  42. hacking Tendermint with the commands below.
  43. NOTE: In case you installed Vagrant in 2017, you might need to run
  44. `vagrant box update` to upgrade to the latest `ubuntu/xenial64`.
  45. ```
  46. vagrant up
  47. vagrant ssh
  48. make test
  49. ```
  50. ## Changelog
  51. Every fix, improvement, feature, or breaking change should be made in a
  52. pull-request that includes an update to the `CHANGELOG_PENDING.md` file.
  53. Changelog entries should be formatted as follows:
  54. ```
  55. - [module] \#xxx Some description about the change (@contributor)
  56. ```
  57. Here, `module` is the part of the code that changed (typically a
  58. top-level Go package), `xxx` is the pull-request number, and `contributor`
  59. is the author/s of the change.
  60. It's also acceptable for `xxx` to refer to the relevent issue number, but pull-request
  61. numbers are preferred.
  62. Note this means pull-requests should be opened first so the changelog can then
  63. be updated with the pull-request's number.
  64. There is no need to include the full link, as this will be added
  65. automatically during release. But please include the backslash and pound, eg. `\#2313`.
  66. Changelog entries should be ordered alphabetically according to the
  67. `module`, and numerically according to the pull-request number.
  68. Changes with multiple classifications should be doubly included (eg. a bug fix
  69. that is also a breaking change should be recorded under both).
  70. Breaking changes are further subdivided according to the APIs/users they impact.
  71. Any change that effects multiple APIs/users should be recorded multiply - for
  72. instance, a change to the `Blockchain Protocol` that removes a field from the
  73. header should also be recorded under `CLI/RPC/Config` since the field will be
  74. removed from the header in rpc responses as well.
  75. ## Branching Model and Release
  76. All repos should adhere to the branching model: http://nvie.com/posts/a-successful-git-branching-model/.
  77. This means that all pull-requests should be made against develop. Any merge to
  78. master constitutes a tagged release.
  79. ### Development Procedure:
  80. - the latest state of development is on `develop`
  81. - `develop` must never fail `make test`
  82. - never --force onto `develop` (except when reverting a broken commit, which should seldom happen)
  83. - create a development branch either on github.com/tendermint/tendermint, or your fork (using `git remote add origin`)
  84. - make changes and update the `CHANGELOG_PENDING.md` to record your change
  85. - before submitting a pull request, run `git rebase` on top of the latest `develop`
  86. ### Pull Merge Procedure:
  87. - ensure pull branch is based on a recent develop
  88. - run `make test` to ensure that all tests pass
  89. - merge pull request
  90. - the `unstable` branch may be used to aggregate pull merges before fixing tests
  91. ### Release Procedure:
  92. - start on `develop`
  93. - run integration tests (see `test_integrations` in Makefile)
  94. - prepare changelog:
  95. - copy `CHANGELOG_PENDING.md` to top of `CHANGELOG.md`
  96. - run `python ./scripts/linkify_changelog.py CHANGELOG.md` to add links for
  97. all issues
  98. - run `bash ./scripts/authors.sh` to get a list of authors since the latest
  99. release, and add the github aliases of external contributors to the top of
  100. the changelog. To lookup an alias from an email, try `bash
  101. ./scripts/authors.sh <email>`
  102. - reset the `CHANGELOG_PENDING.md`
  103. - bump versions
  104. - push to release/vX.X.X to run the extended integration tests on the CI
  105. - merge to master
  106. - merge master back to develop
  107. ### Hotfix Procedure:
  108. - start on `master`
  109. - checkout a new branch named hotfix-vX.X.X
  110. - make the required changes
  111. - these changes should be small and an absolute necessity
  112. - add a note to CHANGELOG.md
  113. - bump versions
  114. - push to hotfix-vX.X.X to run the extended integration tests on the CI
  115. - merge hotfix-vX.X.X to master
  116. - merge hotfix-vX.X.X to develop
  117. - delete the hotfix-vX.X.X branch
  118. ## Testing
  119. All repos should be hooked up to [CircleCI](https://circleci.com/).
  120. If they have `.go` files in the root directory, they will be automatically
  121. tested by circle using `go test -v -race ./...`. If not, they will need a
  122. `circle.yml`. Ideally, every repo has a `Makefile` that defines `make test` and
  123. includes its continuous integration status using a badge in the `README.md`.