Skip to content

Commit b4c325c

Browse files
authored
Added guide to contribute
1 parent 39eda05 commit b4c325c

File tree

1 file changed

+64
-12
lines changed

1 file changed

+64
-12
lines changed

CONTRIBUTING.md

Lines changed: 64 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,64 @@
1-
Steps to follow to contribute to the project
2-
3-
1. Clone the repository
4-
2. Navigate into the repo and run
5-
6-
```
7-
npm install
8-
```
9-
3. To start the server run
10-
```
11-
npm start
12-
```
1+
# Follow these steps to contribute
2+
3+
1. Go to preferred folder in your computer and paste the following command after forking our repository (Only one of it if you don't have ssh setup then go with HTTP command)
4+
5+
```
6+
git clone https://github.com/<YOUR-USERNAME>/Bon-Hack-tit.git
7+
```
8+
9+
2. Navigate to the project folder
10+
11+
```
12+
cd Bon-Hack-tit/
13+
```
14+
15+
3. Install dependencies
16+
17+
```bash
18+
npm i
19+
```
20+
21+
4. Now do ahead and create a new branch and move to the branch
22+
23+
```bash
24+
git checkout -b fix-issue-<ISSUE-NUMBER>
25+
```
26+
27+
> **Note**: Replace `<ISSUE-NUMBER>` with the issue number you are working on
28+
29+
5. Run in local
30+
31+
```bash
32+
npm start
33+
```
34+
35+
> Add new features or fix bugs according to your issue number
36+
37+
6. After done you can now push this changes, for doing that follow the following command chain
38+
39+
- `git status -s` (Shows the changed files)
40+
- `git add --all` (Will add all the files to staging area)
41+
- `git commit -m "feat/docs/fix: <EXPLAIN-YOUR_CHANGES>"`
42+
43+
> **Note**: Replace `<EXPLAIN-YOUR_CHANGES>` with the changes you have made. Also, follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for writing commit messages
44+
45+
- `git remote add upstream https://github.com/coder12git/Bon-Hack-tit.git`
46+
- `git push origin fix-issue-<ISSUE-NUMBER>`
47+
48+
7. After this go to your forked GitHub repository and go to `Pull Request` section. Now you might be able to see a pop up saying **Pull Request**. Click on the popup and you will be redirected to pull request page
49+
50+
8. Now fill in the form template of the pull request and give the necessary description.
51+
52+
9. Click on **Submit**
53+
54+
10. Hurray! You just made your first contribution to this project 🎉
55+
56+
11. Wait for your pull request to be reviewed and merged.
57+
58+
## Useful Links
59+
60+
- [GitHub Forking Guide](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
61+
- [GitHub Pull Requests Guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
62+
- [GitHub Issues Guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues)
63+
- [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)
64+
- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

0 commit comments

Comments
 (0)