Skip to content

Commit b5298cb

Browse files
authored
Create CONTRIBUTING.md
1 parent f9e5ec4 commit b5298cb

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

CONTRIBUTING.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contribution
2+
If this is your first time to open source contribution and you know only python, then you have arrived at the right repository.
3+
4+
# How to contribute!
5+
6+
## Steps:
7+
- I would suggest you to create an issue for the development you want to make in the project. Though it isn't mandatory.
8+
9+
- Fork this [repository](https://github.com/DeepNinja07x/Python_Scripts)
10+
11+
- Clone the forked https://github.com/<Your_Username>/PyScripts
12+
> git clone https://github.com/<Your_Username>/Python_Scripts.git
13+
14+
- Create new branch
15+
> git checkout -b <Your_Branch_Name>
16+
17+
- Add Scripts related to your respective issues.
18+
> git add <Your_Contribution>
19+
20+
- Add a commit message !
21+
> git commit -a -m "<Your_Message>
22+
23+
- Push changes
24+
> git push -u origin <Name_Of_Your_Branch>
25+
26+
- Create pull requests
27+
[Try to Mention the related issue for your PR]
28+
<br/>
29+
// After Contributing add your name and GitHub handle at Contributors.md
30+
31+
# How to Sync the Repo!
32+
33+
## Steps:
34+
- When you see your repo is behind from the main project's repo in terms of commits. Just sync your repo with the main project's repo.
35+
36+
> git remote -v
37+
38+
- Add the upstream (main project's) repo's URL
39+
40+
> git remote add upstream https://github.com/DeepNinja07x/Python_Scripts.git
41+
42+
- Now fetch all the new commits from upstream to your local repo.
43+
44+
> git fetch upstream
45+
46+
- Just check if you are in master branch before merging. If not just change your branch to master branch
47+
48+
> git checkout master
49+
50+
- Merge the upstream branch with your master branch
51+
52+
> git merge upstream/master
53+
54+
- push those changes to your GitHub repository
55+
56+
> git push origin master

0 commit comments

Comments
 (0)