mazipan / hello-open-source

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

Hello Open Source 🖐️

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

🌎 Translations

Sorted alphabetically

• Bengali (বাংলা)
• Chinese (中文)
• French (Français)
• German (Deutsch)
• Hindi (हिंदी)
• Hinglish (Hinglish)
• Hungarian (Hungarian)
• Indonesian (Bahasa Indonesia)
• Italian (Italiano)
• Japanese (日本人)
• Korean (한국어)
• Portuguese (Português)
• Russian (русский)
• Spanish (Española)
• Telugu {తెలుగు}
• Thai (ไทย)
• Urdu (اردو)

❓ 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: '[email protected]',
  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

hello-open-source's Issues

Add eslint with standard.js

Please add eslint with standard.js to this file.

Fix typos in German translation

Issue Description
The German translation has some issues and typos.

Proposed Changes
I proposed some changes in relation to formal/informal languages which are mixed in the translation.

How to Implement
You can take the plain code in this issue to update the translation.

Add hook pre-commit to run eslint

After #3 and #5 already solved, we need to force running eslint every before committing file.

Use husky for add git hook pre-commit.
Sample of this hook, you can see here https://github.com/mazipan/awesome-sde-id-medium/blob/master/package.json

Update README-FR.MD

Is your feature request related to a problem? Please describe.
No

Describe the solution you'd like
Updating existing languages ​​in the README-FR.md file

Add a Luganda translation.

Am suggesting the adding of the Luganda language as a way of enabling more contributors to the project and as well enabling more new contributors to learn. Thank you.

Translation into several languages

It's cool to support multiple languages since so many countries doesn't know English well.

Here are some of main language that we need to support first, but not limited with other languages:

• China
• Japan
• Korea

Add package.json to this repo

Please add package.json to this repo since we need to add some task with JavaScript.

Put Readme translations in translations directory

Root of the project is looking bit cluttered because of all the Readme translations present in the root only.

To solve this, we can create a directory with name Translations which will contains all the translations of the Readme file. We can link this Translations in main README.md. This will make this project more structured and bit less cluttered.

What are your thoughts on this?

branch name in README documentation

Describe the bug
The README documentation contains .js in branch name.

To Reproduce
Steps to reproduce the behavior:

1. Go to How to contribute section.
2. Check third point.
3. Create a new branch with your github username as a branch name, example: add-mazipan.js.

Expected behavior
It should be "Create a new branch with your github username as a branch name, example: add-mazipan."

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: Windows 11
• Browser [chrome
• Version

Additional context
Add any other context about the problem here.

Pull requests here won’t count toward Hacktoberfest.

Hi there,

Thank you for your interest in Hacktoberfest and in helping others make their first contributions to open source.

While we agree that it's important to help others, this repository does not do this in a way that is in line with the Hacktoberfest values. Please read the part that talks about high-quality contributions to understand why we are reaching out and taking action. Due to this, we've added this repository to the list of excluded repositories which means pull requests here will not count toward Hacktoberfest 2020.

This is not a DigitalOcean decision, it's one that is inspired by the community of maintainers and contributors who all agree that quality is more important than quantity when it comes to engagement in the Open Source community. The values remind us to shift the focus from contributions to repositories that encourage folks to quickly create and gain a pull request to contributions that will help people level-up their skills and contribute to open-source projects that are in need of help.

If you feel that this repository is an effective learning resource, we encourage you to keep running it since a core part of the aim for Hacktoberfest is to encourage new folks to get involved with open-source.

However, if you are interested in having contributions to this repo count toward Hacktoberfest we encourage you to take a look at this list of Hacktoberfest issues for inspiration and make the necessary changes to focus on enabling people to make meaningful contributions to open source projects.

If you have any questions about this or participating in Hacktoberfest, please contact our team via email [email protected] or join our community Discord server.

Happy Hacking,
The Hacktoberfest Team

Hacktoberfest is presented by DigitalOcean, Intel and DEV.

GitHub actions: Install dependencies

https://github.com/mazipan/hello-open-source/runs/4025478691?check_suite_focus=true

yarn install v1.22.17
[1/4] Resolving packages...
error Your lockfile needs to be updated, but yarn was run with `--frozen-lockfile`.
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
Error: Process completed with exit code 1.

Auto comment failed

Currently, Actions for auto comment is failed.
I think it because most of PR is forked.
Need to use direct hit using cURL on bash script using personal access token.

test issue create

[First Timer Only] - Create PR with adding your name to this repo

Read complete guidance in readme.md

Difficult to follow contribution guidelines on readme

Describe the bug
Following the contribution guidelines does not look beginner friendly.
I believe instructions to be step-by-step guide that will aid beginners to contribute without sweating out.
Using unordered list is really confusing, showing that one choose where to begin.

Expected behavior

• I suggest it should be ordered list with screenshot or code blocks describing in detailed information the expected result from the contributor

Screenshots

Desktop (please complete the following information):

• OS: Ubuntu
• Browser firefox

File not following the guidelines

Describe the bug
The file vidhijain.js does not follows the guidelines mentioned in the Readme.md

To Reproduce
When we raise a new PR it shows error in the Lint Files, I have mentioned the screenshot of the same below

Screenshots

Edit another test again again

Add German Translation

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Add script to delete data

It's good if I have script to delete some data.
Maybe some like this:

yarn purge mazipan other_name other_name_again

error 404

Describe the bug
On clicking any link of language under main readme.md works fine, but when we click any link of any readme.md files under translations directory is showing error 404

Expected behavior
Every readme.md under translations folder must be updated such that it works fine

Add Arabic language

Is your feature request related to a problem? Please describe.
No

Describe the solution you'd like
I'm adding Arabic translation to the README