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

Labels

Labels:

Comments

Post a Comment

Popular posts from this blog

Going Faster

Photo by  Anders Jildén  on  Unsplash Today’s topic is compiler optimizations. Besides translating our source code into machine binary executable, the compiler, based on optimization parameters, can also produce faster executables. Just by adding some parameters to the compiler, we can get a better performance or a smaller executable, for example. There are hundreds of those parameters which we can turn on or off using the prefix -f and -fno. However, instead of doing one by one, we can use the features mode using the -O param. It ranges from 0 (no optimization – the default) to 3 (the highest). Using those parameters has a cost —usually, the faster, the larger executable. How does the compiler make it faster if my code is perfect? I’m going to put some methods here, but if you want, here is more detail . Also, bear in mind that most of the optimizations are done in the intermediate representation of the program. So, the examples below are rewritten just to...
Post a Comment
Read more

Hello World in Assembly

Photo by  Martin Sanchez  on  Unsplash Assembly alert! I promised to talk more about the compiler, but before it, more assembly. It is for a good reason, though. I was surprised to see my professor doing the “hello world” in assembly! Not only on x86_64 but also in the ARMv8 – different source code. He coded just like C or C++, saved, compiled and run it. The output was exactly like any other language. Nobody knew, but he was doing the Lab 5! I wish I were recording it. Our goal in this class was to compare the compiler output with the hand-crafted assembly. As expected, the compiler produced non-optimal executables even when we played with some fine-tuning options that I mentioned in the last post. How to compile an assembly code? Here are the commands: - Using GNU Assembler > as -g -o test.o test.s > ld -o test test.o - Using NASM Assembler > nasm -g -f elf64 -o test.o test.s > ld -o test test.o - Using GCC > gcc -g -o test.o test.S ...
Post a Comment
Read more

SIMD - Single Instruction Multiple Data

Photo by  Vladimir Patkachakov  on  Unsplash Hi! Today’s lecture, we learned SIMD - Single Instruction Multiple Data. This is a great tool to process data in a bulk fashion. So, instead of doing one by one, based on the variable size, we can do 16, 8, 4 or 2 at the time. This technique is called auto-vectorization resources, and it falls into the category of machine instruction optimization that I mentioned in my last post. If the machine is SIMD enabled, the compiler can use it when translating a sum loop, for example. If we are summing 8 bits numbers, using SIMD, it will be 16 times faster. However, the compiler can figure that it is not safe to use SIMD due to overlapping or non-aligned data. In fact, the compiler will not apply SIMD in most cases, so we need to get our hands dirty and inject some assembly. I’ll show you how to do it in a second. Here are the lanes of the 128-bit AArch64 Advanced SIMD: 16 x 8 bits 8 x 16 bits 4 x 32 bits 2 x 64 bits 1 x ...
Post a Comment
Read more