Skip to content

Commit 0242c5a

Browse files
Update CONTRIBUTING.md (#34)
Successfully added and altered the CONTRIBUTING.md file to include instructions to contribute using GitHub Desktop.
1 parent 451cfee commit 0242c5a

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,31 +40,49 @@ We welcome contributions from the community to enhance GitGlance further.You can
4040
1. **Download and Install GitHub Desktop**:
4141
- Go to the [GitHub Desktop website](https://desktop.github.com/) and download the GitHub Desktop application.
4242
- Follow the installation instructions to install GitHub Desktop on your computer.
43+
- Launch GitHub Desktop and log in to your GitHub account if you haven't already.
4344

4445
2. **Clone the Repository**:
4546
- Open GitHub Desktop and sign in to your GitHub account.
4647
- Click on the "File" menu, then select "Clone Repository..."
47-
- Choose the repository you want to clone from the list or enter its URL.
48-
- Choose the local path where you want to clone the repository and click "Clone".
48+
- Choose the gitglance repository you want to clone from the list or enter its URL.
49+
- Choose the local path where you want to clone the gitglance repository and click "Clone".
4950

50-
3. **Make Changes**:
51+
3. **Switch to the Correct Branch:**
52+
- Ensure you are on the branch that you want to submit a pull request for.
53+
- If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.
54+
55+
4. **Make Changes**:
5156
- After cloning the repository, you can make changes to the files locally using your preferred code editor.
5257

53-
4. **Commit Changes**:
58+
5. **Commit Changes**:
5459
- Once you've made changes, open GitHub Desktop.
5560
- You'll see a list of files with changes. Write a summary and description of your changes in the text fields.
56-
- Click "Commit to main" to commit your changes locally.
61+
- Click the "Commit to <branch-name>" button to commit your changes to the local branch.
5762

58-
5. **Push Changes**:
59-
- To push your changes to the remote repository on GitHub.com, click "Push origin".
63+
6. **Push Changes**:
64+
- To push your changes to the remote repository on GitHub.com, click "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
6065

61-
6. **Pull Changes**:
66+
7. **Pull Changes**:
6267
- If there are changes on the remote repository that you don't have locally, you can pull them by clicking "Fetch origin" or "Pull origin".
6368

64-
7. **Sync Changes**:
69+
8. **Sync Changes**:
6570
- To synchronize your local repository with the remote repository, click "Sync" to push and pull changes in one step.
6671

72+
9. **Create a Pull Request:**
73+
- Go to the GitHub website and navigate to your fork of the repository.
74+
- You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
75+
76+
10. **Review and Submit:**
77+
- On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
78+
- Once you're satisfied, click the "Create pull request" button to submit your pull request.
79+
80+
11. **Wait for Review:**
81+
Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the gitglance repository.
82+
6783
That's it! You can now use GitHub Desktop to manage this repository efficiently.
84+
⭐️ Support the Project
85+
If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors.
6886

6987
## **Pull Request Process 🚀**
7088

0 commit comments

Comments
 (0)