Hello Open Source 🖐️

A repository to learn about open source code contributions flow (for beginner only)

🌎 Translations

Sorted alphabetically

Chinese (中文)
German (Deutsche)
Indonesian (Bahasa Indonesia)
Japanese (日本人)
Korean (한국어)
Portuguese (Português)
Russian (русский)
Spanish (Española)
Thai (ไทย)

❓ How to contribute

Fork this repo, read how to fork repo
Checkout your forked repo to your computer, read how to clone repo
Create a new branch with your github username as a branch name, example: add-mazipan.js.
You can use command: git checkout -b YourUsername/YourBranchName, ex: git checkout -b mazipan/add-mazipan

DO NOT use master or main branch to create a Pull Request. Read article about how to creating a branch

Make sure you are on the new branch, use this command to check your current branch: git branch --show-current
Add your first file with this name github_username.js on the people directory inside your new branch.
Add these code in your new file:

module.exports = {
  name: 'YOUR_NAME',
  github: 'XXX',
  email: 'xxx@xxx.com',
  twitter: '@xxx',
  facebook: 'xxx',
  linkedin: 'in/xxx'
};

Create a pull request to master branch in this repository, read how creating pull request
Don't forget to give your 🌟 to this repository, you can check in stargazers page
Help me to follow github @mazipan
I will check your PRs, and will add invalid label and close the PRs those not following the steps correctly
Have fun, and welcome to the open source world.
Keep in mind, quality is always number one when creating PRs, read the instructions carefully.

💰 Is this a data collection?

No, this repo is intended for learning purpose.

🥶 Do I need to attach my real name?

No, you can put a fake data. We just want to learn about a contributtion flow in the open source ecosystem.

🙈 Do it with your own risk

We don't collect any data. But there is a chance for other people to abuse your data. Please do it with your own risk. We don't protect your data.

⤵️ How do I retrieve someone's data?

git clone https://github.com/mazipan/hello-open-source # clone the repo
cd hello-open-source # cd into the repo
node index.js caxvis # will return this person's named caxvis to you

🗑️ How to remove my data?

Remove all data

yarn purge

You can specify a name (or more) to remove only those file(s)

yarn purge joe-bob kitty-luvr73

❌ I will delete the data periodically.

🚶 Next Step

This repo will introduce to open source contribution flow. After finishing all steps here, we expect you will have a basic knowledge in how to fork repository, know how a git branch works, how to create a good pull request and other basic things to make your next contribution in open source code 🥳.

👉 Do NOT stop here, keep contribute to open source code

Tijani-zainab/hello-open-source