Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 2.75 KB

first-timers.md

File metadata and controls

70 lines (47 loc) · 2.75 KB

How To Contribute to ruby-http-client for first-timers

We know that contributing to an open source project for the first time can be intimidating.

This documentation serves to guide you on how to make your first contribution.

Assuming you already have a Github account, here are the steps to make your first contribution:

Finding a task you can handle

We label our issues according to their difficulty level. You can find easy ones here but feel free to explore other labels too.

Creating a Pull Request

  1. Fork the project, clone your fork, and configure the remotes:

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

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
git pull upstream <dev-branch>

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. 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.

4a. Create tests.

4b. 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 master

  2. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  3. Open a Pull Request with a clear title and description against the master branch. All tests must be passing before we will review the PR.

If you have any additional questions, please feel free to email us or create an issue in this repo.