Skip to content

Commit 3b4e350

Browse files
committedMar 14, 2021
Added the contributing.md file
1 parent 7d9a6cd commit 3b4e350

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed
 

‎CONTRIBUTING.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
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. You may also raise an issue.
2+
To start contributing, follow the below guidelines:
3+
4+
**1.** Fork [this](https://github.com/Spectrum-CETB/LesKollab) repository.
5+
6+
**2.** Clone your forked copy of the project.
7+
8+
```
9+
git clone https://github.com/<your_username>/LesKollab.git
10+
```
11+
12+
**3.** Navigate to the project directory :file_folder: .
13+
14+
```
15+
cd LesKollab
16+
```
17+
18+
**4.** Add a reference(remote) to the original repository.
19+
20+
```
21+
git remote add upstream https://github.com/Spectrum-CETB/LesKollab
22+
```
23+
24+
**5.** Check the remotes for this repository.
25+
26+
```
27+
git remote -v
28+
```
29+
30+
**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository).
31+
32+
```
33+
git pull upstream master
34+
```
35+
36+
**7.** Create a new branch.
37+
38+
```
39+
git checkout -b <your_branch_name>
40+
```
41+
42+
**8.** Perfom your desired changes to the code base.
43+
44+
**9.** Track your changes:heavy_check_mark: .
45+
46+
```
47+
git add .
48+
```
49+
50+
**10.** Commit your changes .
51+
52+
```
53+
git commit -m "Commit Message"
54+
```
55+
56+
**11.** Push the committed changes in your feature branch to your remote repo.
57+
58+
```
59+
git push -u origin <your_branch_name>
60+
```
61+
62+
**12.** To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.
63+
64+
65+
**13.** Add appropriate title and description to your pull request explaining your changes and efforts done.
66+
67+
68+
**14.** Click on `Create Pull Request`.
69+
70+
71+
**15** Yay! You have made a PR to the project. Sit back patiently and relax while the your PR is reviewed.

0 commit comments

Comments
 (0)
Please sign in to comment.