Skip to content

Contributing Guide

Jump to bottom
Kevin Mulhern edited this page Dec 10, 2016 · 14 revisions
  1. Find an issue tagged with "help wanted" to work on.

If It's a lesson issue you can choose to work on one or more parts of the lesson which are outlined in the progress list in an lesson issue or you can work on completing the entire lesson. Whatever you choose please leave a comment on the issue saying you are working on a part or the whole lesson to claim it.

  1. Download the curriculum to your local machine

    • Fork and clone the curriculum to your local machine, use this guide if you don't know how to do that
    • Set the upstream remote so you can keep your copy of the curriculum synced with the original. To do that go to your terminal and cd into your cloned odin project curriculum directory. Then use one of the following commands:

    If you have ssh set up with Git

    $ git remote add upstream [email protected]:TheOdinProject/curriculum.git

    Otherwise

    $ git remote add upstream https://github.com/TheOdinProject/curriculum.git

  2. Before you start working on your issue create a branch and name it like the following examples: If its a new lesson

$ git checkout -b lesson/new-lesson-name`

If it's a part of a lesson

$ git checkout -b lesson/new-lesson-section-name`

If its a typo or grammar fix

$ git checkout -b fix/what-you-fixed`

If you are working on a new lesson or part of new lesson please work in the template which is linked to in the issue you have chosen.

  1. When you have finished and are ready to submit a Pull request: Please make your commit messages descriptive based on what you've done.

Push your branch to your fork

$ git push origin <your branch name here>

Create a pull request

  • Go to your fork on Github after you have pushed up your branch. A new button should be visible near the top of the page. It will allow you to create a pull request to the original Odin Project Repo.

  • Please Link to the issue your pull request resolves in the body of your pull request.

##Need Help with Anything Here? Please let us know if you require any help doing any of the steps in this guide in our contributing channel on gitter

Clone this wiki locally