My first Pull Request

-
For the next lab for my Open Source class, the goal is to create a repository with a simple open source library, let other students contribute to my library, while I got the chance to contribute to their repositories. The library is meant to get simple file information, such as file name, file size, and sha1/MD5 digest. I decided to write my library in JavaScript. I created four empty functions, raises 4 issues, and then waited for someone else to create a pull request against my code. Lately I was the one that would go into different Git project, look through all the issues to find the good first issue label. It was a nice change to create these issues myself, and then place labels on them.



Eventually another student changed some of my code sent a pull request. I accepted it and merged his code together with him. I closed one of my issues, maybe someone else will come and help me out with the others.



Now I had to contribute to another student's project. I knew the basics of Git, how to clone a repository to my local machine, pulling, pushing. I never understood the concept of pull request, or how to do one. I previously tried submitting a pull request but I was always afraid that I would mess something up. This was the perfect opportunity for me to create my first pull request because this is a lab intended just for this, there is no way I can mess this up. I decided to go with feihaozi77's project BuildingJSLibrary. Feihaozi77 had 2 issues raised, one for an MD5 digest, and the other for a sha1 digest. I forked the project, cloned it to my local machine, and started working away on it. Once I had code that was working properly, I pushed it to my GitHub then created a Pull request for my issue. Creating the Pull request was much simpler then I thought! I had to select two branches to compare, I used my branch against the master, and I created the Pull request.


The author had some troubles running the code, I think my instructions weren't very clear. Let's hope the author accepts the pull request now after clearing it up!




I feel that with this lab complete, I learned a lot more about Git. I learned how to create and accept a Pull request, how to raise issues, what is a fork. I now feel comfortable working on larger projects and contributing to them.

Comments

Post a Comment

Popular posts from this blog

Building Mozilla web browser from source

-
Image
This week I built the Firefox web browser from source. Mozilla currently has about 17,998,723 line of code, it is mostly built with C++ but also includes other languages such as HTML, C, JavaScript, Rust, and many more. I personally use Mozilla as my preferred browser, so it was interesting to download and modify the source code. Mozilla has easy to read  instructions  that I followed for downloading the source code, building it, then running. I'm using Mozilla on a Windows 10 system. Some of the prerequisites include installing Visual Studio with certain workloads, Rust, MAPI Header Files, and MozillaBuild. Once I installed everything necessary, I was ready to pull the Firefox source code using the command hg clone https://hg.mozilla.org/mozilla-central And then the wait begins. After patiently waiting for the a while, the downloading aborts. Uh oh, what happened? The message read: "Rust compiler not found". I have installed the Rust compiler and have ...
Read more

First bugs completed

-
Image
After working on my bugs for the past few weeks, I've finally completed two of my bugs! The bugs themselves were very simple to solve, but in this process, I've learned how to use a variety of different Git command, including clone, pull, add, fork, and pull request. I use to feel lost while using Git, now I'm much more confident with my new skills. Neither of my bugs were software-breaking bugs, and most users wouldn't even notice them. I finished my first bug in my previous blog, you can go and view it here . Deep inside of Firefox's Dev-tools, one button's boundaries extended to the end of the screen, instead of around the image only. The fix was relatively easy, a CSS class was already created and I only had to place the class name in the correct spot on the HTML page. I left the last blog after I completed the bug, without creating a Pull Request. During my previous lab, I practiced creating a Pull Request, so I had an idea on how to do it this time. I cr...
Read more

Async image load test with gh-pages

-
Image
I finally got the opportunity to try out GitHub Pages. GitHub Pages is a simple static HTML page that we can create from our GitHub repositories. It is perfect for documentation or anything related to the project. To get started, a gh-pages branch must first be created, and then it can be further setup in the settings section. For this project, I wrote a test case for async image loading. I built a simple page that would allow me to test this in multiple browsers. The page is very simple with an image, a counter, and a button to reload the image. As the user clicks the button, the image is reloaded. If the image is reloaded, the background changes colours and the counter is updated. The async testing has passed on all the browsers except for Safari. I decided to dig deeper into this and Safari is like this. I had to dig pretty deep into the webkit source files to see where the load event is fired. After digging around for a little bit, I found the ImageLoader.cpp file. The na...
Read more