Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 912 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 912 Bytes
Raw

How to Contribute

We'd love to get patches from you!

Getting Started

We follow the GitHub Flow Workflow

  1. Fork the project
  2. Check out the master branch
  3. Create a feature branch
  4. Write code and tests for your change
$ cd ./twurl

# install twurl from source
$ bundle install

# run twurl from source
$ bundle exec twurl -v

# run tests
$ bundle exec rake
  1. From your branch, make a pull request against twitter/twurl/master
  2. Work with repo maintainers to get your change reviewed
  3. Wait for your change to be pulled into twitter/twurl/master
  4. Delete your feature branch

License

By contributing your code, you agree to license your contribution under the terms of the MIT License: https://github.com/twitter/twurl/blob/master/LICENSE

Code of Conduct

Read our Code of Conduct for the project.