Skip to content

Commit

Permalink
Merge pull request #108 from Priyanshu2631/Updated-Contributing.md
Browse files Browse the repository at this point in the history
Added instruction on how to use Github desktop
  • Loading branch information
TAHIR0110 authored Aug 8, 2024
2 parents 5d54d62 + 8d829de commit ebec267
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,55 @@ in case you are stuck:
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources)


### Alternatively contribute using GitHub Desktop

1. **Open GitHub Desktop:**
Launch GitHub Desktop and log in to your GitHub account if you haven't already.

2. **Clone the Repository:**
- If you haven't cloned the ThereForYou repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
- Choose the ThereForYou repository from the list of repositories on GitHub and clone it to your local machine.

3. **Switch to the Correct Branch:**
- Ensure you are on the branch that you want to submit a pull request for.
- If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

4. **Make Changes:**
Make your changes to the code or files in the repository using your preferred code editor.

5. **Commit Changes:**
- In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
- Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to <branch-name>" button to commit your changes to the local branch.

6. **Push Changes to GitHub:**
After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

7. **Create a Pull Request:**
- Go to the GitHub website and navigate to your fork of the ThereForYou repository.
- You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

8. **Review and Submit:**
- 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.
- Once you're satisfied, click the "Create pull request" button to submit your pull request.

9. **Wait for Review:**
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 ThereForYou repository.

## 📈 Development Workflow

When working on the project, please follow these guidelines:

1. Always work on a new branch for each separate issue or feature.
2. Keep your branch up to date with the main repository's `master` branch.
3. Write clear and descriptive commit messages.
4. Test your changes thoroughly before submitting a pull request.
5. Keep discussions polite and respectful.


<br>


## **Issue Report Process 📌**

1. Go to the project's issues.
Expand Down

0 comments on commit ebec267

Please sign in to comment.