Takuya Kikuchi
TK's Blog โœ๏ธ

TK's Blog โœ๏ธ

How to make your first OSS contribution

Takuya Kikuchi's photo
Takuya Kikuchi
ยทOct 22, 2022ยท

3 min read

Play this article

About this article

This article is a summary of what I did for my first OSS contribution. ๐Ÿ‘Ÿ I hope this article to be helpful for junior engineers who want to contribute to OSS but don't know what to do.

TL;DR

  • Correcting/translating documentation
  • Correcting/translating Tutorial

I believe it is a good idea to start with these areas. There are rather many opportunities to correct minor mistakes and mistranslations in documents and tutorials that we use on a daily basis for work and study, if we are aware of them. Why not start with a small contribution? ๐Ÿ‘

The path I followed

Now, I will describe what I actually did after I decided to become an OSS contributor. ๐Ÿ˜ค

1. Understand what OSS contributions are

First, I searched for information on how to contribute to OSS. Among several articles I read, I recommend the following article because it was comprehensive about OSS contributions.

opensource.guide/ja/how-to-contribute

  • What is OSS Contribute and what is good about it
  • How OSS Contributions can be made
  • The structure of an open project
  • How to find projects to contribute to
  • Checklist before contributing

2. Practice the OSS contribution flow

I found a repository where you can practice the flow of OSS contributions, so I did it.

github.com/firstcontributions/first-contrib..

3. I joined a translation community

Mozilla Japan's community translates MDN into Japanese. I have always been curious about it, so I joined.

mozilla.doorkeeper.jp

I was a bit nervous about joining for the first time, but the onboarding materials were well-prepared and regular members helped me via Slack, so I was able to work on the translation without any problems.

By the way, here is the page I translated ๐Ÿ˜Ž.

developer.mozilla.org/ja/docs/Glossary/DSL

It's a small contribution, but it made me feel proud to be able to contribute to MDN, which I use all the time โœจ

4. Make minor corrections to the documentation that I encounter during my daily work and study

Once I made the first OSS contribution, I felt like the hurdle of OSS contribution was somehow lowered all the more. ๐Ÿš€ From there, I made minor corrections to the documentation I encountered during my daily work and study, as well as corrections to translations.

Fixing translations of Web.dev Japanese pages github.com/GoogleChrome/web.dev/pull/8594

Storybook Tutorial Japanese page translation corrections github.com/shippio/back-office-next/pull/103

Fixed sample code in Rollbar documentation Fixes to the sample code in the Rollbar documentation rollbar-oss-contribute

In the future

Fixing documentation and translations is an important contribution, but I want to make technical contributions too!! ๐Ÿง‘๐Ÿปโ€๐Ÿ’ป

When I encounter problems or improvements in the language or packages I use, I want to be proactive by raising an Issue or submitting a PR, rather than being passive. ๐Ÿ’ช

If you can't find it in your daily work, you can use the label good-first-issue to find issues for beginners. ๐Ÿ”ฐ

github.com/topics/good-first-issue goodfirstissues.com goodfirstissue.dev/language/javascript

Happy OSS Contribution! ๐ŸŽ‰

The article is also available in Japanese: zenn.dev/takuyakikuchi/articles/a663c523823..

ย 
Share this