Skip to content

Commit 2a5423d

Browse files
committed
contributing instructions
1 parent 9f60e10 commit 2a5423d

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,44 @@
11
# Beginner-Python-Submissions
2+
# Contribution is fun! :green_heart:
3+
4+
In order to make a hassle-free environment, I implore you all (_while contributing_) to follow the instructions mentioned below!
5+
6+
Happy Submissions :slightly_smiling_face:
7+
8+
## :arrow_down: Installation
9+
10+
- First, fork this repository :fork_and_knife: and follow the given instructions:
11+
12+
```bash
13+
# clone the repository to your local machine
14+
$ git clone https://github.com/<YOUR-GITHUB-USERNAME>/Beginner-Python-Submissions.git
15+
16+
# navigate to the project's directory and install all the relevant dev-dependencies
17+
$ cd Beginner-CPP-Submissions
18+
19+
# include all the latest changes from the remote repository
20+
$ git remote add upstream https://github.com/Girl-Code-It/Beginner-Python-Submissions.git
21+
$ git fetch upstream
22+
$ git merge upstream/master
23+
```
24+
25+
- Add your submissions for the milestone you are working on in the respective milestone folder
26+
- Once you have made your changes, run the following command:
27+
28+
```bash
29+
# add your changes
30+
$ git add .
31+
32+
# make your commit
33+
$ git commit -m "<YOUR-COMMIT-MESSAGE>"
34+
35+
# push your changes
36+
$ git push -u origin master #for first time push
37+
$ git push #from second push onwards
38+
```
39+
40+
> Think you're ready :grey_question: Make the PR :tropical_drink:
41+
- open your forked repository
42+
- Click on Create New Pull Request
43+
- Give a message in the comment box about the PR
44+
- Hurrah!! Your first PR made! Wait for your submission to be accepted and your PR to be merged

0 commit comments

Comments
 (0)