How to Contribute¶ ↑
We'd love to get patches from you!
Getting Started¶ ↑
We follow the GitHub Flow Workflow
-
Fork the project
-
Check out the
master
branch -
Create a feature branch
-
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
-
From your branch, make a pull request against
twitter/twurl/master
-
Work with repo maintainers to get your change reviewed
-
Wait for your change to be pulled into
twitter/twurl/master
-
Delete your feature branch
License¶ ↑
By contributing your code, you agree to license your contribution under the terms of the MIT License: github.com/twitter/twurl/blob/master/LICENSE
Code of Conduct¶ ↑
Read our Code of Conduct for the project.