Skip to content

Commit 1ffec7c

Browse files
Update README.md
1 parent 30a72dc commit 1ffec7c

File tree

1 file changed

+190
-2
lines changed

1 file changed

+190
-2
lines changed

README.md

+190-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,190 @@
1-
# Awesome-Python-Projects
2-
Contribute in this repository by raising genuine PR. Get verified, merged aand earn the free swags from Hacktoberfest 2022.
1+
# Hacktoberfest 2022 Is Awesome🔥
2+
![image](https://user-images.githubusercontent.com/70385488/192114009-0830321a-d227-4a4d-8411-6c03b54d7ce6.png)
3+
4+
<div align="center">
5+
6+
[![Open Source Love](https://firstcontributions.github.io/open-source-badges/badges/open-source-v1/open-source.svg)](https://github.com/kishanrajput23/Hacktoberfest-2022)
7+
<img src="https://img.shields.io/badge/HacktoberFest-2022-blueviolet" alt="Hacktober Badge"/>
8+
<img src="https://img.shields.io/static/v1?label=%E2%AD%90&message=If%20Useful&style=style=flat&color=BC4E99" alt="Star Badge"/>
9+
<a href="https://github.com/kishanrajput23" ><img src="https://img.shields.io/badge/Contributions-welcome-green.svg?style=flat&logo=github" alt="Contributions" /></a>
10+
11+
</div>
12+
13+
14+
### This repository aims to help code beginners with their first successful pull request and open source contribution. :partying_face:
15+
16+
:star: Feel free to use this project to make your first contribution to an open-source project on GitHub. Practice making your first pull request to a public repository before doing the real thing!
17+
18+
:star: Make sure to grab some cool swags during Hacktoberfest by getting involved in the open-source community.
19+
20+
### This repository is open to all members of the GitHub community. Any member can contribute to this project! :grin:
21+
22+
## What is Hacktoberfest? :thinking:
23+
A month-long celebration from October 1st to October 31st presented by [Digital Ocean](https://hacktoberfest.digitalocean.com/) and [DEV Community](https://dev.to/) collaborated with [GitHub](https://github.com/blog/2433-celebrate-open-source-this-october-with-hacktoberfest) to get people involved in [Open Source](https://github.com/open-source). Create your very first pull request to any public repository on GitHub and contribute to the open-source developer community.
24+
25+
[https://hacktoberfest.digitalocean.com/](https://hacktoberfest.digitalocean.com/)
26+
27+
## Rules :fire:
28+
To qualify for the __official limited edition Hacktoberfest shirt__, you must register [here](https://hacktoberfest.digitalocean.com/) and make four Pull Requests (PRs) between October 1-31, 2022 (in any time zone). PRs can be made to any public repository on GitHub, not only the ones with issues labeled Hacktoberfest. This year, the __first 40,000__ participants who complete the challenge will earn a T-shirt.
29+
30+
## Steps to follow :scroll:
31+
32+
### Tip : Complete this process in GitHub (in your browser)
33+
34+
```mermaid
35+
flowchart LR
36+
Fork[Fork the project]-->branch[Create a New Branch]
37+
branch-->Edit[Edit file]
38+
Edit-->commit[Commit the changes]
39+
commit -->|Finally|creatpr((Create a Pull Request))
40+
41+
```
42+
43+
### 0. Star The Repository :star2:
44+
45+
Star the repository by pressing the topmost-right button to start your wonderful journey.
46+
47+
### 1. Fork it :fork_and_knife:
48+
49+
You can get your own fork/copy of [HacktoberFest-2022](https://github.com/kishanrajput23/Hacktoberfest-2022) by using the <a href="https://github.com/kishanrajput23/Hacktoberfest-2022/new/master?readme=1#fork-destination-box"><kbd><b>Fork</b></kbd></a> button.
50+
51+
52+
### 2. Clone it :busts_in_silhouette:
53+
54+
`NOTE: commands are to be executed on Linux, Mac, and Windows(using Powershell)`
55+
56+
You need to clone or (download) it to local machine using
57+
58+
```sh
59+
$ git clone https://github.com/Your_Username/Hacktoberfest-2022.git
60+
```
61+
62+
> This makes a local copy of the repository in your machine.
63+
64+
Once you have cloned the `Hacktoberfest-2022` repository in Github, move to that folder first using change directory command on Linux, Mac, and Windows(PowerShell to be used).
65+
66+
```sh
67+
# This will change directory to a folder Hacktoberfest-2022
68+
$ cd Hacktoberfest-2022
69+
```
70+
71+
Move to this folder for all other commands.
72+
73+
### 3. Set it up :arrow_up:
74+
75+
Run the following commands to see that *your local copy* has a reference to *your forked remote repository* in Github :octocat:
76+
77+
```sh
78+
$ git remote -v
79+
origin https://github.com/Your_Username/Hacktoberfest-2022.git (fetch)
80+
origin https://github.com/Your_Username/Hacktoberfest-2022.git (push)
81+
```
82+
83+
Now, let's add a reference to the original [Hacktoberfest-2022](https://github.com/kishanrajput23/Hacktoberfest-2022/) repository using
84+
85+
```sh
86+
$ git remote add upstream https://github.com/kishanrajput23/Hacktoberfest-2022.git
87+
```
88+
89+
> This adds a new remote named ***upstream***.
90+
91+
See the changes using
92+
93+
```sh
94+
$ git remote -v
95+
origin https://github.com/Your_Username/Hacktoberfest-2022.git (fetch)
96+
origin https://github.com/Your_Username/Hacktoberfest-2022.git (push)
97+
upstream https://github.com/Remote_Username/Hacktoberfest-2022.git (fetch)
98+
upstream https://github.com/Remote_Username/Hacktoberfest-2022.git (push)
99+
```
100+
`In your case, you will see`
101+
```sh
102+
$ git remote -V
103+
origin https://github.com/Your_Username/Hacktoberfest-2022.git (fetch)
104+
origin https://github.com/Your_Username/Hacktoberfest-2022.git (push)
105+
upstream https://github.com/kishanrajput23/Hacktoberfest-2022.git (fetch)
106+
upstream https://github.com/kishanrajput23/Hacktoberfest-2022.git (push)
107+
```
108+
109+
### 4. Sync it :recycle:
110+
111+
Always keep your local copy of the repository updated with the original repository.
112+
Before making any changes and/or in an appropriate interval, run the following commands *carefully* to update your local repository.
113+
114+
```sh
115+
# Fetch all remote repositories and delete any deleted remote branches
116+
$ git fetch --all --prune
117+
118+
# Switch to `main` branch
119+
$ git checkout main
120+
121+
# Reset local `main` branch to match the `upstream` repository's `main` branch
122+
$ git reset --hard upstream/main
123+
124+
# Push changes to your forked `Hacktoberfest-2021` repo
125+
$ git push origin main
126+
```
127+
128+
### 5. Ready Steady Go... :turtle: :rabbit2:
129+
130+
Once you have completed these steps, you are ready to start contributing by checking our `Good First Issue` Issues and creating [pull requests](https://github.com/kishanrajput23/Hacktoberfest-2022/pulls).
131+
132+
### 6. Create a new branch :bangbang:
133+
134+
Whenever you are going to contribute. Please create a separate branch using command and keep your `main` branch clean (i.e. synced with remote branch).
135+
136+
```sh
137+
# It will create a new branch with name Branch_Name and switch to branch Folder_Name
138+
$ git checkout -b BranchName
139+
```
140+
141+
Create a separate branch for contribution and try to use the same name of the branch as of folder.
142+
143+
To switch to the desired branch
144+
145+
```sh
146+
# To switch from one folder to other
147+
$ git checkout BranchName
148+
```
149+
150+
To add the changes to the branch. Use
151+
152+
```sh
153+
# To add all files to branch Folder_Name
154+
$ git add .
155+
```
156+
157+
Type in a message relevant for the code reviewer using
158+
159+
```sh
160+
# This message get associated with all files you have changed
161+
$ git commit -m 'relevant message'
162+
```
163+
164+
Now, Push your awesome work to your remote repository using
165+
166+
```sh
167+
# To push your work to your remote repository
168+
$ git push -u origin BranchName
169+
```
170+
171+
Finally, go to your repository in the browser and click on `compare and pull requests`.
172+
Then add a title and description to your pull request that explains your precious effort.
173+
174+
## Awesome contributors :star_struck:
175+
<a href="https://github.com/kishanrajput23/Hacktoberfest-2022/graphs/contributors">
176+
<img src="https://contributors-img.web.app/image?repo=kishanrajput23/Hacktoberfest-2022" />
177+
</a>
178+
179+
Made with [contributors-img](https://contributors-img.web.app).
180+
181+
182+
## Help Contributing Guides :crown:
183+
184+
We love to have `articles` and `codes` in different languages and the `betterment` of existing ones.
185+
186+
Please discuss it with us first by creating a new issue.
187+
188+
:tada: :confetti_ball: :smiley: _**Happy Contributing**_ :smiley: :confetti_ball: :tada:
189+
190+
## Author🙍‍♂️ : [Find Me Here](https://linktr.ee/kishan_rajput23)

0 commit comments

Comments
 (0)