Skip to content

Commit 2d596b4

Browse files
Merge pull request #248 from harshal255/patch-2
README.md 📚💡
2 parents 443963a + 071ba4c commit 2d596b4

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,78 @@
1+
# Contribution is fun! :green_heart:
2+
3+
In order to make a hassle-free environment, I implore you all (_while contributing_) to follow the instructions mentioned below!
4+
5+
Happy Submissions :slightly_smiling_face:
6+
7+
## Contribution Guidelines🏗
8+
9+
Are we missing any of your favorite features, which you think you can add to it❓ We invite you to contribute to this project and make it better.
10+
To start contributing, follow the below guidelines:
11+
12+
**1.** Fork this repository.
13+
14+
**2.** Clone your forked copy of the project.
15+
16+
```
17+
git clone https://github.com/<your_user_name>/Portfolio-Collection.git
18+
```
19+
20+
**3.** Navigate to the project directory :file_folder: .
21+
22+
```
23+
cd Portfolio-Collection
24+
```
25+
26+
**4.** Add a reference(remote) to the original repository.
27+
28+
```
29+
git remote add upstream https://github.com/avinash201199/Portfolio-Collection.git
30+
```
31+
32+
**5.** Check the remotes for this repository.
33+
34+
```
35+
git remote -v
36+
```
37+
38+
**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
39+
40+
```
41+
git pull upstream main
42+
```
43+
44+
**7.** Create a new branch.
45+
46+
```
47+
git checkout -b <your_branch_name>
48+
```
49+
50+
**8.** Perform your desired changes to the code base.
51+
52+
**9.** Track your changes:heavy_check_mark: .
53+
54+
```
55+
git add .
56+
```
57+
58+
**10.** Commit your changes .
59+
60+
```
61+
git commit -m "Relevant message"
62+
```
63+
64+
**11.** Push the committed changes in your feature branch to your remote repo.
65+
66+
```
67+
git push -u origin <your_branch_name>
68+
```
69+
70+
**12.** To create a pull request, click on `compare and pull requests`.
71+
72+
**13.** Add appropriate title and description to your pull request explaining your changes and efforts done.
73+
74+
**14.** Click on `Create Pull Request`.
75+
76+
77+
**15** Voila :exclamation: You have made a PR to the Portfolio-Collection :boom: . Wait for your submission to be accepted and your PR to be merged.(Hacktoberfest 2023)
178

0 commit comments

Comments
 (0)