Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

44 lines (34 loc) · 1.37 KB

Contributing

We'd love your help making tchannel-go great!

Getting Started

TChannel uses glide to manage dependencies. To get started:

go get github.com/uber/tchannel-go
make install_glide
make  # tests should pass

Making A Change

Before making any significant changes, please open an issue. Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.

Once we've discussed your changes and you've got your code ready, make sure that tests are passing (make test or make cover) and open your PR! Your pull request is most likely to be accepted if it:

Cutting a Release

  • Send a pull request against dev including:
    • update CHANGELOG.md (scripts/changelog_halp.sh)
    • update version.go
  • Send a pull request for dev into master
  • git tag -m v0.0.0 -a v0.0.0
  • git push origin --tags
  • Copy CHANGELOG.md fragment into release notes on https://github.com/uber/tchannel-go/releases