Hacktoberfest pull request 1

I will try to practice how to use pull request to fix issues within open source programs in release0.2 of OSD600 course. This month I am planning to pull 4 requests step by step from easy to difficult. I hope to improve my ability to fix issues of open source programs through this practice. 

First of all, I try to search for some issues in GitHub. I select a simple issue for my first pull request. When I search for "add .editorconfig", There are a lot of issues about it. I can clarify them by programming languages.

                                                            Search for issues

Obviously, I need to understand what is editorconfig when I choose this subject. EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. I think most of programs should include this file. In this way, it can keep you code readable even if other developers pull requests to promote your code. 

After searching I choose an active project named dpkp/kafka-python which has an issue #2125 needed to be fixed about .editorconfig. Then I fork this repo and clone this repo to my local host. Through studying code style of the author, I create a new .editorconfig file for this project. It can ask developers to keep the  same format when they contribute to the same project across various editors and IDEs. 

At last, I push the new .editorconfig file to my forked repos. Then I pull a request to the author's repos through comparing the difference betrween the two repos.

For the first pull request work, I think that the hardest part is how to find a suitable issue to deal with. It is a time-consuming work to searching for issues and we need pay enough patient.

Comments

Post a Comment

Popular posts from this blog

Open source development course

 I'm Leon and a student of Computer Programming & Analysis program in Seneca College. I am taking OSD600 course of this semester in Toronto .   I am vey interesting in the open source. The course is my opportunity to know more things about it.  Open source development can provide us the opportunities to work with the developers around the world.  Open source technology and open source thinking also can benefit everyone, not only programmers. I want to study the open source tools and accumulate the development experience of real software project. I'm gonna search for commercial service development projects to understand the requirements of a business project. The GitHub trending repo I research is  Rocket.Chat . It is Open Source Solution for team communications.  Instant messaging is a widely used network application. I want to know how to develop this kinds of softwares. I'm gonna share my learning process with this course during this semester in my bl...
Read more

Choose a project in Release 0.4

 Release 0.4 is my fourth assignment for OSD600 course. There are three steps to complete it. The first step is to choose a project which you will work with. The second step is to update the process about the work. The last step is to show my result for the project. Because it is close to my test week. I don't have enough time to search for a new suitable project. So, I decide to work with the former project in this course. Actually I plan to work with my link checker project . I had designed some features which can be used to test if a link work well. But I think there are still something which I can promote. This is true for every IT project, and you can continually improve the project to make it better and better. In the first assignment for this course, my professor list many optional features which can be designed into the link check project. I will choose one of them which I don't complete to further refine my project.
Read more

The software testing in Lab 8

Image
 This week we start to practice how to test the project with a testing framework. In the lab, I choose Jest to test my link checker project  written by JavaScript.  Jest  is a testing framework developed by Facebook. Originally designed to make UI testing easier for React developers, it’s now a full standalone suite of tools for any type of JavaScript project (including Node.js) and includes features such as a built-in assertion library, code coverage, and mocking. Jest also runs multiple test suites concurrently, which can speed up the overall testing process.  Jest has a lot of advantages, so I want to use it. First of all, I install the Jest to my local project using the command " npm install --save-dev jest ". Then I write three unit tests for reading a file and requesting a url by creating two new .test.js files. After completing the coding, I try to test them using the command "npm run test" and it works well. Unit test Second, I add some scripts in the p...
Read more