Skip to content

Commit 11c3100

Browse files
GauravSahu891fineanmol
authored andcommitted
Improved readability of CONTRIBUTING.md without altering important details
1 parent 0cc5bf9 commit 11c3100

File tree

1 file changed

+16
-22
lines changed

1 file changed

+16
-22
lines changed

CONTRIBUTING.md

+16-22
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11
# Contribution Guidelines 📚
22

3-
Welcome to our project! We appreciate your interest and contributions. Please read the following guidelines carefully to ensure a smooth collaboration.
3+
Welcome to Our Project!
4+
Thank you for your interest in contributing! Please read the following guidelines carefully to ensure smooth collaboration.
45

5-
## General Rules:
6-
7-
- **Creativity Allowed:** Feel free to submit pull requests that break the rules—we might just merge them anyway!
8-
- **No Build Steps:** Avoid adding build steps like `npm install` to maintain simplicity as a static site.
9-
- **Preserve Existing Content:** Do not remove existing content.
10-
- **Code Style:** Your code can be neat, messy, simple, or complex. As long as it works, it's welcome.
11-
- **Add Your Name:** Remember to add your name to the `contributorsList` file.
12-
- **Keep it Small:** Aim for small pull requests to minimize merge conflicts and streamline reviews.
6+
## General Guidelines:
7+
**Creativity Allowed:** If you have an idea that bends the rules, feel free to submit a pull request (PR). We may still merge it!
8+
**No Build Steps:** Please avoid adding build steps (e.g., npm install). This project is intended to stay simple as a static site.
9+
**Preserve Existing Content:** Ensure you do not remove any existing content.
10+
**Code Style:** Whether your code is clean or messy, simple or complex—it’s all welcome, as long as it works.
11+
**Add Your Name:** Don’t forget to add your name to the contributorsList file.
12+
**Keep it Small:** Try to keep your pull requests small. This helps minimize merge conflicts and makes reviews easier.
1313

1414
## Getting Started 🤩🤗
1515

1616
1. **Fork the Repository:**
17-
- Use the fork button at the top right of the repository page.
17+
- Click the "Fork" button at the top right of the repository page to create your own copy of the project.
1818

1919
2. **Clone Your Fork:**
2020
- Clone the forked repository to your local machine.
2121

2222
```bash
23-
git clone https://github.com/fineanmol/Hacktoberfest2024.git
23+
git clone https://github.com/your-username/Hacktoberfest2024.git
2424
```
2525

2626
3. **Navigate to the Project Directory:**
2727

2828
```bash
29-
cd Hacktoberfest2024
30-
```
29+
cd Hacktoberfest2024
30+
```
3131

32-
4. **Create a New Branch:**
32+
4. **Create a New Branch:**
3333

3434
```bash
3535
git checkout -b my-new-branch
@@ -56,11 +56,6 @@ Welcome to our project! We appreciate your interest and contributions. Please re
5656

5757
8. **Create a Pull Request:**
5858
- Go to your forked repository on GitHub and create a pull request to the main repository.
59-
60-
## Avoiding Conflicts {Syncing Your Fork}
61-
62-
To keep your fork up-to-date with the main repository and avoid conflicts:
63-
6459
1. **Add Upstream Remote:**
6560

6661
```bash
@@ -82,9 +77,8 @@ To keep your fork up-to-date with the main repository and avoid conflicts:
8277

8378
This will pull in changes from the parent repository and help you resolve any conflicts.
8479

85-
4. **Keep Updated:**
80+
4. **Stay Updated:**
8681
- Regularly pull changes from the upstream repository to keep your fork updated.
8782

88-
We look forward to your contributions and thank you for being a part of our community!
89-
83+
We appreciate your contributions and are excited to have you as part of our community! Thank you for helping improve our project!
9084

0 commit comments

Comments
 (0)