Skip to content

Commit fa73fa3

Browse files
Easy understanding of contribution with screenshots for beginners in Readme.md. (#817)
1 parent a0c742f commit fa73fa3

File tree

3 files changed

+48
-83
lines changed

3 files changed

+48
-83
lines changed

Fork_Screenshot.png

66.1 KB
Loading

README.md

Lines changed: 48 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,63 @@
1-
# Hello Open Source 🖐️
2-
3-
A repository to learn about open source code contributions flow (_for beginners only_).
4-
5-
## 🌎 Translations
6-
7-
_Sorted alphabetically_
8-
9-
- [Arabic](./translations/README-AR.md) (**العربية**)
10-
- [Bengali](./translations/README-BN.md) (**বাংলা**)
11-
- [Chinese](./translations/README-CHI.md) (**中文**)
12-
- [French](./translations/README-FR.md) (**Français**)
13-
- [German](./translations/README-DE.md) (**Deutsch**)
14-
- [Hindi](./translations/README-HI.md) (**हिंदी**)
15-
- [Hinglish](./translations/README-HINGLISH.md) (**Hinglish**)
16-
- [Hungarian](./translation/README-HU.md) (**Hungarian**)
17-
- [Indonesian](./translations/README-ID.md) (**Bahasa Indonesia**)
18-
- [Italian](./translations/README-it.md) (**Italiano**)
19-
- [Japanese](./translations/README-JP.md) (**日本人**)
20-
- [Korean](./translations/README-KR.md) (**한국어**)
21-
- [Portuguese](./translations/README-PT-BR.md) (**Português**)
22-
- [Russian](./translations/README-RU.md) (**русский**)
23-
- [Spanish](./translations/README-ES.md) (**Española**)
24-
- [Telugu](./translations/README-TE.md) (**తెలుగు**)
25-
- [Thai](./translations/README-TH.md) (**ไทย**)
26-
- [Urdu](./translations/README-UR.md) (**اردو**)
27-
28-
<br>
29-
30-
## ❓ How to contribute
31-
32-
- Fork this repo, read [how to fork repo](https://help.github.com/articles/fork-a-repo/)
33-
- Checkout your forked repo to your computer, read [how to clone repo](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
34-
- Create a new `branch` with your GitHub username as a branch name, for example: `add-mazipan`.
35-
- You can use the following command:
36-
```shell
37-
git checkout -b YourUsername/YourBranchName`
38-
```
39-
- Ex: `git checkout -b mazipan/add-mazipan`
40-
41-
> **⚠️ DO NOT use `master` or `main` branch to create a Pull Request**.
42-
> Read the article about [how to create a branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/)
43-
44-
- Make sure you are on the new branch, use this command to check your current branch: `git branch --show-current`
45-
- Add your first file named `github_username.js` to the `people` directory inside your new branch.
46-
- Add these codes to your new file:
47-
48-
```js
49-
module.exports = {
50-
name: 'YOUR NAME',
51-
github: 'XXX',
52-
53-
twitter: '@xxx',
54-
facebook: 'xxx',
55-
linkedin: 'in/xxx',
56-
}
1+
# 👋 Hello Open Source
572

58-
```
3+
A repository to **learn open source contribution flow** — perfect for **beginners**! Follow the easy steps below to make your first Pull Request (PR) without stress.
594

60-
- Create a pull request to the `master` branch in this repository, read [how to create pull request](https://help.github.com/articles/creating-a-pull-request/)
61-
- Don't forget to give your 🌟 to this repository, you can check in [stargazers page](https://github.com/mazipan/hello-open-source/stargazers)
62-
- Help me to follow github [@mazipan](https://github.com/mazipan)
63-
- I will check your PRs, and will **add an `invalid` label** and **close the PRs** of those not following the steps correctly
64-
- Have fun, and welcome to the open-source world.
65-
- Keep in mind, that quality is always number one when creating PRs, read the instructions carefully.
5+
---
666

67-
<br>
7+
## 🌍 Translations Available
8+
9+
You can read this guide in your preferred language:
10+
11+
- [Arabic](./translations/README-AR.md)
12+
- [Bengali](./translations/README-BN.md)
13+
- [Chinese](./translations/README-CHI.md)
14+
- [French](./translations/README-FR.md)
15+
- [German](./translations/README-DE.md)
16+
- [Hindi](./translations/README-HI.md)
17+
- [Hinglish](./translations/README-HINGLISH.md)
18+
- [Hungarian](./translation/README-HU.md)
19+
- [Indonesian](./translations/README-ID.md)
20+
- [Italian](./translations/README-it.md)
21+
- [Japanese](./translations/README-JP.md)
22+
- [Korean](./translations/README-KR.md)
23+
- [Portuguese](./translations/README-PT-BR.md)
24+
- [Russian](./translations/README-RU.md)
25+
- [Spanish](./translations/README-ES.md)
26+
- [Telugu](./translations/README-TE.md)
27+
- [Thai](./translations/README-TH.md)
28+
- [Urdu](./translations/README-UR.md)
6829

69-
## 💰 Is this a data collection?
30+
---
7031

71-
No, this repo is intended for learning purposes.
72-
<br>
32+
## 🪜 How to Contribute (Step-by-Step)
7333

74-
## 🥶 Do I need to attach my real name?
34+
> Follow these steps to make your first open-source contribution smoothly.
7535
76-
No, you can put a fake data.
77-
We just want to learn about a contribution flow in the open-source ecosystem.
36+
1. **Fork this repository**
37+
- Go to the top-right corner of [this repo](https://github.com/mazipan/hello-open-source) and click the `Fork` button.
38+
- You'll have a copy of this repository in your own GitHub account.
39+
- Screenshot for this is provided here.
40+
![Fork Screenshot](Fork_Screenshot.png)
41+
- This will create a copy of the repo under your GitHub account.
7842

79-
<br>
43+
2. **Clone your forked repository**
44+
- Go to your GitHub account and navigate to your forked repository.
45+
- Click the `Code` button and copy the URL.
46+
-Screenshot for this is provided here.
47+
![Clone Screenshot](clone_repo.png)
48+
- Open your terminal and run:
8049

81-
## 🙈 Do it at your own risk
50+
```bash
51+
git clone https://github.com/YOUR-USERNAME/hello-open-source.git
52+
```
8253

83-
We don't collect any data.
84-
But there is a chance for other people to abuse your data.
85-
Please do it at your own risk.
86-
**We don't protect your data**.
87-
<br>
54+
- Replace `YOUR-USERNAME` with your actual GitHub username.
8855

89-
## ⤵️ How do I retrieve someone's data?
56+
3. **Navigate into the project folder**
57+
58+
```bash
59+
cd hello-open-source
9060
91-
```shell
92-
git clone https://github.com/mazipan/hello-open-source # clone the repo
93-
cd hello-open-source # cd into the repo
94-
node index.js github_milan960 # will return this person's named github_milan960 to you
95-
```
9661
9762
## 🗑️ How do I remove my data?
9863

clone_repo.png

120 KB
Loading

0 commit comments

Comments
 (0)