Skip to content

How to Contribute?

Akshay Rai edited this page Jan 13, 2017 · 2 revisions

General instructions on how to contribute for Newbies?

Step 1: Create an account on github.

Step 2: Fork your own copy of Dr. Elephant into your github account by clicking on the "Fork" button present at the right top corner of this page.

Step 3: Navigate to your account and clone that copy to your development box

git clone https://github.com/<username>/dr-elephant

Step 4: Create a branch and start working on your change.

Step 5: Once you have done all the changes make a local commit and push to your repository.

Step 6: Now you need to create a Pull Request(PR). You can do this from the github UI. Follow these instructions.

Step 7: Once you have successfully created a PR, someone from the Dr. Elephant team will review and approve or request changes if any. If any changes are requested then you need make those changes in your already checked out copy(same branch), make a local commit and push them to your repository.

Step 8: Soon after pushing the changes to your repository, the PR will get updated. You can now go and comment on the PR asking for a review.

Step 9: Once all the changes are approved, someone from the Dr. Elephant team will push the change to the upstream code. Thats it! Congratulations