Saturday, October 11, 2014

I made my first contribution to an open source project!

Today I was working on my node app and I was looking up how the res.redirect method in Express worked.

 I then found a typo in the deprecate message so I decided to make my very first contribution to an open source project!!! It was a fairly trivial change but I submitted it anyways, it was exhilerating!

Here's what I did:

  1. Forked the repository (I went to https://github.com/strongloop/express and clicked on the fork button)
  2. Clone the repository locally
    > git clone git@github.com:strongloop/express.git
  3. Corrected the typo
  4. Committed my changes and pushed it to my branch. 
  5. Make a pull request! https://github.com/strongloop/express/pulls -- click on the green "New pull request" button! This step is to merge your changes to the main code repository.


That's it!!!
After making the pull request, the automated build (Travis CI) ran and passed (obviously) and shortly after, my changes were accepted. :D

In summary, when you want to make changes to a git repository essentially what you do is fork the project, make changes locally, and make a pull request to get your changes accepted and pulled into the main branch.

This is my very first open source contribution! More to come..
If you're curious...
https://github.com/strongloop/express/pull/2395#issuecomment-58762835

Cheers,
Bess

No comments:

Post a Comment