Five steps to becoming a contributor to a well-known and acclaimed open source project

The following could theoretically be compiled for any well-known and highly praised open source project you want to work on, at the risk of being looked down upon

This is a good first attempt to submit pull requests on Github

Go straight to the core steps

A, the premise

  • 1. Git has been installed locally and you are familiar with git commands

  • 2. You have a Github account and have associated the local Git mailbox with Github

  • 3. Vscode has been installed on the local PC

Github: Fork/React

  • 1. Open your browser, go to Github, search for ‘React’, go to the target project, and tap Fork in the upper right corner to go to your repository

  • Git clone forks the React project repository

Install vsCode Spell Checker

Objective: To quickly locate misspelled words in open source projects for us.

4, in the source code to find annotations word error, modify commit

Why look for errors in annotation words? The risk is minimal because of the error of the annotation word, and the speed of the PR merge is extremely efficient (more exaggerated is that you submit the entire PR process, the project does not need to install dependencies and run unit tests, of course, from a responsible point of view, it is recommended to install dependencies and run unit tests).

  • 1. Use VScode to open the clone project

  • 2. Open the source Code as much as you want. If you find a word wrong in the source Code, vsCode Code Spell Checker will “environement”: Unknown Word. It is advisable to look at the words in the annotation. It is really a matter of luck to find the wrong words

  • 3. Repair, can open Google translation check, combined with the prompt of Code Spell Checker, can quickly repair the word, for safety, can choose the obvious error of the word or can also be combined with the whole annotation statement (choose the most reliable word, do not choose the word, such as: libuv)

  • 4. Git commit. In particular, it is recommended to go to Github corresponding open source project to find a similar word fix and have been merged PR, follow the commit format

git add .
git commit -n -m"Fix typo in comment (environement → environment)" 
Copy the code

Submit PR to open source projects

  • 1. Create a fix branch and commit it to the project repository of your own fork
git checkout -b fix-react-reconciler-comment
git push origin fix-react-reconciler-comment
Copy the code
  • 2. Submit the Pull Request to the open source project, focusing on filling in the following information about the current PRFunctional description, each project PR description format is different, similar to the above reference fix andThe PR that has been mergedDescription format of
## Summary

Fixed minor typo inThe comment. Environement - environmentCopy the code
  • 3. Click on theCreate pull request

If the project PR is submitted for the first time, the corresponding CLA needs to be signed

6. Digression

A preview of the merged image

After going through the above process, you have a 99.99% chance of becoming a contributor for your target well-known and highly praised open source project (wait for PR review from the open source author, of course), so what happens next?

Since the above steps can theoretically be applied to any well-known and highly praised open source project you want to participate in, you can choose your favorite open source project, personally recommended to choose your own technology stack related

Then, you can configure your Github presence

Conclusion:

Above is pure play, must not abuse

Ultimate hope: embrace open source projects and learn more source code

The articles

Rough notes based on Qiankun Micro front-end Combat + deployment (skip principle)