Skip to content

Commit

Permalink
Precise Contributing Section with Guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
Aayush2308 committed Oct 17, 2024
1 parent 7cd7590 commit 2844d1d
Showing 1 changed file with 74 additions and 38 deletions.
112 changes: 74 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,47 +56,83 @@ Being an open source contributor doesn't just mean writing code, either. You can

**We're accepting PRs for our open and unassigned [issues🐛](https://github.com/Kushal997-das/Project-Guidance/issues)**. Please check [CONTRIBUTING.md✨](https://github.com/Kushal997-das/Project-Guidance/blob/main/CONTRIBUTING.md). We'd love your contributions! **Kindly follow the steps below to get started:**

**0.** Star [this](https://github.com/Kushal997-das/Project-Guidance) repository.
**Steps:**
1. **Star this Repository ⭐**
![image](https://github.com/user-attachments/assets/522d9797-31d2-4606-a234-373f41874466)

**1.** Fork [this](https://github.com/Kushal997-das/Project-Guidance) repository.

**2.** Clone the forked repository.
2. **Fork the Repository:**

```bash
git clone https://github.com/<your-github-username>/Project-Guidance
```

**3.** Navigate to the project directory.

```bash
cd Project-Guidance
```

**4.** Create a new branch.

```bash
git checkout -b <your_branch_name>
```

**5.** Make changes.

**6.** Stage your changes and commit

```bash
git add -A

git commit -m "<your_commit_message>"
```

**7.** Push your local commits to the remote repo.

```bash
git push -u origin <your_branch_name>
```

**8.** Create a [PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) to `develop` !

**9.** **Congratulations!** :tada: Sit and relax, you've made your contribution to [Project-Guidance](https://github.com/Kushal997-das/Project-Guidance). :v: :heart: 💥
a. Visit the Repository:

![image](https://github.com/user-attachments/assets/de82dcea-97f2-4eff-a76e-a99d0e17e784)

b. Locate the "Fork" button, usually located in the top-right corner of the repository page, and click it. <br>
c. Choose a Destination: Select the repository's destination, which is typically your personal GitHub account. <br>
d. Create the Fork: Click the "Create fork" button to create a copy of the repository under your account.


3. **Create a folder for this project and open it on your vscode editor**


5. **Clone the Repository:**

* Open your terminal or command prompt and navigate to your desired project directory.
* After that, open your forked repository and click on this **code** button and copy the HTTPS link

![image](https://github.com/user-attachments/assets/7088e896-8f12-432e-8d2c-b81e7cfd2c5d)

* Now write the below command and paste your HTTPS link in vscode terminal
```bash
git clone
```
* Now you have successfully cloned the repository


3. **Navigate to the Project Directory:**
```bash
cd .\Project-Guidance\ (or your project folder name)
```

6. **Create a new branch **
```bash
git checkout -b feature-branch
```
* Replace "feature-branch" with a name that describes the changes you'll make (e.g., "add-dark-mode").
7. **Make your changes and commit them**
```bash
git commit -m 'Add feature' (Replace the message with your specific changes)
```
8. **Push to the branch**
```bash
git push origin feature-branch
```
9. **Raise an Issue**
* Open the repository and click on the issue button
![image](https://github.com/user-attachments/assets/c5768991-21ae-4647-be9b-dc1d1d270b08)
**Some Guidelines for Raising Issues**
* Be specific and concise
* Check for existing issues
* Provide context and background
* Be respectful and constructive
10. **Open a Pull Request (Let's Collaborate! )**
* Click on the "Pull Requests" button (looks like a merge ) next to the Issues button.
**Some Guidelines for Opening a PR that will have high chance of getting merged**
* Follow the project's contribution guidelines (if any).
* Create a clear and informative title for your pull request.
* Provide detailed descriptions of the changes you made.
* Address any feedback promptly and make adjustments as needed.
* Test your changes thoroughly before submitting the pull request.
11. **Good Luck! (We Can't Wait to See What You Build!)**


<br><br>

Expand Down

0 comments on commit 2844d1d

Please sign in to comment.