First, read the contribution guidelines. Ensure you understand the code.
The following instructions describe how to fork this repository in order to contribute to this:
-
Fork this repository, see https://help.github.com/articles/fork-a-repo/.
-
Clone your fork:
git clone https://github.com/<username>/odyssey.iiitd.edu.in.git
Where
<username>
is your github username. -
Add the base repository as a remote:
git remote add upstream https://github.com/<username>/odyssey.iiitd.edu.in.git
-
Follow the instructions in the README files of each of the directories listed under About this Repository section of this readme to set up your development environment.
After you have forked and cloned the repository, use the following steps to make and manage changes. After you have finished making changes, you can submit them to the base repository using a pull request.
-
Pull changes from the base repository's master branch:
git pull upstream master
-
Create a new branch to track your changes:
git checkout -b <branch>
Where
<branch>
is a meaningful name for the branch you'll use to track changes. -
Make and test changes locally.
-
Add your changes to the staging area:
git add <files>
Where
<files>
are the files you changed.Note: Run
git add .
to add all currently modified files to the staging area. -
Commit your changes:
git commit -m <message>
Where
<message>
is a meaningful, short message describing the purpose of your changes. -
Pull changes from the base repository's master branch, resolve conflicts if necessary:
git pull upstream master
-
Push your changes to your github account:
git push -u origin <branch>
Where
<branch>
is the branch name you used in step 2. -
Create a pull request to have your changes reviewed and merged into the base repository. For more information on creating pull requests, see https://help.github.com/articles/creating-a-pull-request/.
To learn more about referencing issues in your pull request or commit messages, see https://help.github.com/articles/closing-issues-using-keywords/.
-
Celebrate!