Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve contributing guide #1956

Merged
merged 5 commits into from
Aug 4, 2023
Merged

docs: improve contributing guide #1956

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6a29bd0
contributing: Updated the Readme
Parul1606 Aug 4, 2023
63a297b
Merge branch 'main' into test1
priyankarpal Aug 4, 2023
1f0694b
Merge branch 'main' of https://github.com/priyankarpal/ProjectsHut in…
Parul1606 Aug 4, 2023
54a3fc7
docs: improve contributing guide
Parul1606 Aug 4, 2023
89fd8ee
Merge branch 'test1' of https://github.com/Parul1606/ProjectsHut into…
Parul1606 Aug 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,31 +59,41 @@ git clone https://github.com/<YOUR-USERNAME>/ProjectsHut.git
cd ProjectsHut
```

3. Install dependencies
3. Add a reference(remote) to the original repository.
```
git remote add upstream https://github.com/<YOUR_USERNAME>/ProjectsHut.git
Parul1606 marked this conversation as resolved.
Show resolved Hide resolved
```

4. Check the remotes for this repository.
```
git remote -v
```

5. Install dependencies

```bash
pnpm i
```

> **Note**: If you don't have pnpm installed in your system then run this command `npm i -g pnpm`

4. Now do ahead and create a new branch and move to the branch
6. Now do ahead and create a new branch and move to the branch

```bash
git checkout -b fix-issue-<ISSUE-NUMBER>
```

> **Note**: Replace `<ISSUE-NUMBER>` with the issue number you are working on

5. Run in local
7. Run in local

```bash
pnpm dev
```

> Add new features or fix bugs according to your issue number

6. After done you can now push this changes, for doing that follow the following command chain
8. After done you can now push this changes, for doing that follow the following command chain

- `git status -s` (Shows the changed files)
- `git add --all` (Will add all the files to staging area)
Expand All @@ -94,15 +104,15 @@ pnpm dev
- `git remote add upstream https://github.com/priyankarpal/ProjectsHut.git`
Parul1606 marked this conversation as resolved.
Show resolved Hide resolved
- `git push origin fix-issue-<ISSUE-NUMBER>`

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
9. 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

8. Now fill in the form template of the pull request and give the necessary description.
10. Now fill in the form template of the pull request and give the necessary description.

9. Click on **Submit**
11. Click on **Submit**

10. Hurray! You just made your first contribution to this project 🎉
12. Hurray! You just made your first contribution to this project 🎉

11. Wait for your pull request to be reviewed and merged.
13. Wait for your pull request to be reviewed and merged.

## Useful Links

Expand Down