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

Use Static analysis tools in Lab7

Image
 This week we learn to manage our projects using Static analysis tools.  Static analysis tools help us maintain the quality of our source code by fixing formatting issues, spotting suspicious coding constructs, or alerting us to common errors. Now I use my  testLink  project to practice these tools. Create a CONTRIBUTING.md File First, I create a  CONTRIBUTING.md file to  separate the setup and development content from README.md file. Add a Source Code Formatter I pick Prettier formatter for my JavaScript project. Following the instruction, I use the command " npm install --save-dev --save-exact prettier " to install the tool. After installing, I use the command " npx prettier --write . " to formate all my files and " npx prettier --check . " to check the files if there are some wrong formation. I also set the ".prettierrc.json" and ".prettierrcignore" file. Then, I create  a simple "one-step" solution for running my formatte...
Read more

Prepare for Telescope project in Lab6

Image
 This month we will start to work on Telescope project.  Telescope is a somewhat complex system that uses many technologies.  For the first week of this month, we need to prepare something for the project. First of all, I try to set up the  Telescope development environment on my local host.  I have to say, it took me a lot of time to  set up this environment . After searching for and installing relevant applications, I implement the Telescope project successfully. http://localhost:3000/posts http://localhost:3000/feeds Second, I add a new feature in my  Link Checker project  to  check the links in the last 10 posts indexed by my local Telescope. I create a new js file called readUrl to  implement  the function. After modifying the code, I test it successfully.                                                 ...
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