Skip to main content

Open Source Contribution Process Overview


Photo by Mikhail Vasilyev on Unsplash
I’m Rodrigo, a tech guy that never stops to learn. I’ve more than ten years of experience working as an IT Consultant, Java/Web Developer and DBA Oracle, in short, Full Stack Developer. This blog is a way to contribute to the community that gave me so much knowledge and, mostly, because it is a requirement for my SPO600 class at Seneca College.

Setting up a blog was a long-time desire. Hopefully, I like it and extend it to other topics later on. However, here I’ll follow the agenda provided by my professor.

My first assignment is to research how to contribute to opensource projects. I picked Angular and Spring-Boot to dig in. Both licensed under MIT and Apache 2.0, respectively, have a clear code of conduct and contribution instructions, which are very similar to each other. Also, both use GitHub to share its source code, documentation and track issues.

https://github.com/angular/angular/blob/master/CONTRIBUTING.md

https://github.com/spring-projects/spring-boot/blob/master/CONTRIBUTING.adoc

The first step is to sign out the Contributor License Agreement (CLA). It is a sort of contract to ensure our identity and authority. Following the steps, you will create your digital certificate and share your public key with the community.

Next, you need to open an issue in the tracking system providing all the information necessary to recreate the problem. Don’t forget to include the versions of all software involved. If you have the solution to the issue, you are encouraged to share it as well.

Then your request will be analyzed by the core contributors. They might add some tags, call others to check it or even ask you for more information. This process could take hours or months, depending on the issue and the member’s availability.

Considering that your request was accepted, they will ask you to download the source code from the master repository and proceed with the changes. All the files that you changed or created will list you as an author using your digital certificate created in the first step. Attempt to follow all coding style guides provided. Then you have to send or commit your fix into the GitHub. Usually, this process creates a fork, meaning that the change will be done outside of the master source.

After committing, your patch will be extensively tested by the team and the whole community. This step is critical to ensure that it is not going to break anything in the new release, which might include new features and many bug fixes.

Finally, if everything is clear, your piece of code will be incorporated into one of the releases, becoming part of the mater source code.

Please note that this path does not apply to security issues. They have private channels for that.

Here is my general understanding of the process. If you found some error, please reach me out, and I’ll glad to fix it.

See you,
Rodrigo

Comments

Popular posts from this blog

Two-digit Numeric Display - Final

Photo by  Nick Hillier  on  Unsplash In this post, I’ll continue the two-digit numeric display. If you miss it, click here and check it out . To finish this project, we just need to show the numbers in the matrix-pixel (the black-box in the 6502 emulator ). To kickstart, our instructor gave us one example of how to display graphs, which was a lot helpful. The first thing that I’ve noticed was the bitmap table at the bottom. So, I mimic it and made ten tables like that to represent each number (zero to nine). So far, so good! Then I grabbed the logic to display one digit, and then my nightmares just started. How to place two graphs (one for each digit)? How to switch from one number to another? How to reuse code? Where is my coffee?! To emulate some if-elseif-else statements, I used jmp (jump). They are all over the place! However, the 6502 limits the jump range from -127 to 128. That means moving the code-blocks to satisfy all jumps limit. For e...

Project Stage 1

Photo by  SpaceX  on  Unsplash Hello! This is my SPO 600 blog, and this post will be long – sorry. The goal is to pick one project that is CPU intensive, written in C or C++, and experiment different compiler options and present the results. That’s why it will be long – lots of data to show. I choose the AWK project ( https://github.com/onetrueawk/awk ). It is a handy tool to process files. Parse, sort, and filter are some trivial operations that are CPU intensive. To make it harder, I created a huge XML file to parse it and count the tags. I've described the machines in my last post, if you miss it, here it is . I also created a script to run and collect the data. I planned to run each candidate 10 times, but a few attempts didn’t receive any data. So, I decided to nest the loop in a way that even if someone kills my process, the data could be used. Guess what? It happened! To produce the candidates, I just changed the CFLAGS inside the makefile and ran the...

Assembly?

Photo by  Jonas Svidras  on  Unsplash Last week on my SPO course, I had my first experience writing Assembly code. I won’t lie; it was struggling. For me, Assembly is like the Latin of the codding languages and “carpe diem” wasn’t my first lesson. Hexadecimal, binary and a list of instructions is a must know to guarantee survival. Our instructor introduced us to the 6502 processor: it is an old school chip that was used in many home solutions such as PCs and video games. Internally, it has three general-purpose registers, three special-purpose registers, memory and input and output ports. Fortunately, there are emulators on the internet that helps us to focus on the development, hiding the electronic part from us. http://6502.cdot.systems/ Using the emulator, our first task was to copy, paste and execute a piece of code to change the colour of every pixel in the display matrix. That was easy! The result was a yellow screen. Then we were asked t...