Skip to content

Commit 78be1a3

Browse files
Adds CONTRIBUTING.md to the repo (#14)
1 parent 065a9bc commit 78be1a3

File tree

2 files changed

+47
-1
lines changed

2 files changed

+47
-1
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Guideline to contribute to the website
2+
--------------------------------------
3+
4+
- We accept PRs only on `develop` branch. No PRs shall be accepted on `master` branch.
5+
6+
- We prefer small feature changes instead of bulk changes. That makes it easier for both the developer as well as reviewer. Smaller requests would have a faster turn-around time in the review-response cycle.
7+
8+
Workflow
9+
--------
10+
11+
If you're new to git version control system, please follow these guidelines:
12+
13+
- Fork the repo.
14+
- Clone your fork.
15+
- Add upstream remote as
16+
```git remote add upstream [email protected]:LinuxChixIndia/LinuxChixIndia.github.io.git```
17+
18+
- Now create a feature branch to work on the bug/feature request like
19+
```git checkout -b <feature-name>```
20+
21+
- Start working on the issue. Commit early; commit often.
22+
23+
- Open up a Pull Request with base branch as `develop` and compare branch as `feature-branch` of your fork.
24+
25+
- Once you get review, address those in next commits. If you get `LGTM` (Looks good to me) tag on your PR, it's time to get your PR merged. Congrats.
26+
27+
- Last step is to just squash all your commits into one and briefly describe what you did. (Most of the time, the reviewer shall do this for you, but it would be good if you do it by yourself.)
28+
29+
- After squashing, you need to force push to your feature branch.
30+
```git push origin <feature-name> -f```
31+
32+
- Once your PR is merged, it's time to delete the feature branch from your fork (Optional, just to keep your local repo clean)
33+
```git branch -D <feature-name>```
34+
35+
- Since the master/develop of the original project may be ahead now, it's time to pull the changes from the upstream and update on your fork
36+
```git pull upstream develop```
37+
```git push origin develop```
38+
39+
- Now for next feature, repeat!
40+
41+
Happy Contributing!

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
# LinuxChixIndia.github.io
2-
Source code for official website of LinuxChix India
2+
Source code for official website of LinuxChix India.
3+
4+
Contributing
5+
-------------
6+
7+
Please read the [contributing guidelines](./CONTRIBUTING.md) to contribute to the project.

0 commit comments

Comments
 (0)