Skip to content

Commit

Permalink
Merge pull request #3131 from iarmaanx/main
Browse files Browse the repository at this point in the history
Improved Contributing Section in Contributing.md
  • Loading branch information
sailaja-adapa authored Oct 8, 2024
2 parents 9a9e26a + 600b5d7 commit f524e33
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,36 +101,36 @@ Your involvement helps to improve the project and make it better for everyone. T
<hr>

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

2. **Clone the Repository:**
- If you haven't cloned the SwapReads repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
- Choose the SwapReads repository from the list of repositories on GitHub and clone it to your local machine.
- If you haven't cloned the SwapReads repository yet, click on the "File" menu and select "Clone Repository."
- Choose the SwapReads repository from the list 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.
- Ensure you're on the branch you want to submit a pull request for.
- If needed, switch branches by clicking on the "Current Branch" dropdown and selecting the appropriate branch.

4. **Make Changes:**
Make your changes to the code or files in the repository using your preferred code editor.
- Edit 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.
- In GitHub Desktop, you'll see a list of changed files. Check the box next to the files you want to commit.
- Enter a summary and description for your changes, then click "Commit to [branch name]" to commit to your 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.
- After committing, click "Push origin" 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 SwapReads repository.
- You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
- Go to GitHub, navigate to your fork of the SwapReads repository, and click "Compare & pull request."
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.
- On the pull request page, review your changes and add any necessary information (title, description, etc.).
- When ready, click "Create pull request" to submit.
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 SwapReads repository.
- The project maintainers will review your pull request. They may provide feedback or request changes before merging it into the main SwapReads repository.
## **Issue Report Process 📌**
Expand Down

0 comments on commit f524e33

Please sign in to comment.