Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 2.86 KB

FIRST_TIMERS.md

File metadata and controls

53 lines (34 loc) · 2.86 KB
Raw

How To Contribute to Twilio SendGrid Repositories via GitHub

Contributing to the Twilio SendGrid repositories is easy! All you need to do is find an open issue (see the bottom of this page for a list of repositories containing open issues), fix it and submit a pull request. Once you have submitted your pull request, the team can easily review it before it is merged into the repository.

To make a pull request, follow these steps:

  1. Log into GitHub. If you do not already have a GitHub account, you will have to create one in order to submit a change. Click the Sign up link in the upper right-hand corner to create an account. Enter your username, password, and email address. If you are an employee of Twilio SendGrid, please use your full name with your GitHub account and enter Twilio SendGrid as your company so we can easily identify you.

  1. Fork the sendgrid-ruby repository:

  1. Clone your fork via the following commands:
# Clone your fork of the repo into the current directory
git clone https://github.com/your_username/sendgrid-ruby
# Navigate to the newly cloned directory
cd sendgrid-ruby
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/sendgrid/sendgrid-ruby

Don't forget to replace your_username in the URL by your real GitHub username.

  1. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
git checkout -b <topic-branch-name>
  1. Commit your changes in logical chunks.

Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public. Probably you will also have to create tests (if needed) or create or update the example code that demonstrates the functionality of this change to the code.

  1. Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream main
  1. Push your topic branch up to your fork:
git push origin <topic-branch-name>
  1. Open a Pull Request with a clear title and description against the main branch. All tests must be passing before we will review the PR.

Important notice

Before creating a pull request, make sure that you respect the repository's constraints regarding contributions. You can find them in the CONTRIBUTING.md file.