/hello-open-source

🖐️ A repository to learn about open source code contributions flow

Primary LanguageJavaScriptMIT LicenseMIT

Hello Open Source 🖐️

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

🌎 Translations

Sorted alphabetically

❓ 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, for example: add-mazipan.
  • You can use the following 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 the article about how to create 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 named github_username.js to the people directory inside your new branch.
  • Add these codes to 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 the master branch in this repository, read how to create 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 an invalid label and close the PRs of those not following the steps correctly
  • Have fun, and welcome to the open-source world.
  • Keep in mind, that quality is always number one when creating PRs, read the instructions carefully.

💰 Is this a data collection?

No, this repo is intended for learning purposes.

🥶 Do I need to attach my real name?

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

🙈 Do it at your own risk

We don't collect any data. But there is a chance for other people to abuse your data. Please do it at 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 github_milan960 # will return this person's named github_milan960 to you

🗑️ How do I 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 open source contribution flow. After finishing all the steps here, we expect you will have a basic knowledge of how to fork the repository, 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 contributing to open-source projects

Copyright © 2018-2023 Irfan Maulana