Contributing Guide

1. Find an issue that you would like to to work on. Please comment on the issue and wait to be assigned before working on it.

2. Clone the bot and set it up

   • Read this guide for instructions

3. Before you start working on your issue create a branch with the following naming conventions: If it's a new command

$ git checkout -b feature/new-command-name`

If it's an update of an existing command

$ git checkout -b command-name/new-addition-name`

If it's a typo, grammar, or functionality fix

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

4. When you have finished and are ready to submit a Pull request:

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

• Please link to the issue your pull request in the sidebar of the PR or write "closes #" 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 #contributions-bugs-suggestions channel on Discord.