Skip to content

Commit 37ee804

Browse files
committed
fixed CONTRIBUTING.md
1 parent 061e276 commit 37ee804

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

CONTRIBUTING.md

+22-14
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@ Thank you for considering lending your expertise to the "You Don't Need JavaScri
44

55
Let's navigate through these guidelines for a smooth and collaborative contribution process.
66

7-
## Table of Contents
8-
9-
- [How to Contribute](#how-to-contribute)
10-
- [Code of Conduct](#code-of-conduct)
11-
127
## How to Contribute
138

149
🙌 We're all for contributions, be it bug fixes, feature upgrades, or the introduction of new demos. To get started, follow these steps:
@@ -21,44 +16,57 @@ Let's navigate through these guidelines for a smooth and collaborative contribut
2116
```sh
2217
git clone https://github.com/your-username/You-Dont-Need-JavaScript.git
2318
```
24-
2519
3. **Create a New Branch:**
2620
- Forge a new branch for your contribution with a name that paints a picture, e.g., `feature/my-new-demo`.
2721
```sh
2822
git checkout -b feature/my-new-demo
2923
```
30-
3124
4. **Make Your Changes:**
3225
- Work your magic and make the desired changes or additions to the project.
33-
3426
5. **Test Your Changes:**
3527
- Cast a spell of testing to ensure your changes function correctly without introducing any gremlins.
28+
6. **Add Your Work to README:**
29+
- Weave your masterpiece into the README.md following our [Style Guide](README.md#style-guide).
30+
7. **Commit Your Changes:**
31+
- Contribute with meaningful commits that tell the story of your work.
3632

37-
6. **Commit Your Changes:**
38-
- Contribute with meaningful commits that tell the story of your work.
3933
```sh
34+
4035
git commit -m "Add a new demo for XYZ feature"
36+
4137
```
4238

43-
7. **Push to Your Fork:**
39+
8. **Push to Your Fork:**
40+
4441
- Send your enchanting changes to your fork on GitHub.
42+
4543
```sh
44+
4645
git push origin feature/my-new-demo
46+
4747
```
48+
9. **Create a Pull Request (PR):**
4849

49-
8. **Create a Pull Request (PR):**
5050
- Journey to the original repository on GitHub and invoke the "New Pull Request" button.
51+
5152
- Craft a clear and concise title and description for your PR.
53+
5254
- Unveil your PR for the grand review.
5355

54-
9. **Review and Collaboration:**
56+
10. **Review and Collaboration:**
57+
5558
- Join the maintainers in an epic collaboration, addressing feedback or requested changes.
5659

57-
10. **Your PR is Merged:**
60+
11. **Your PR is Merged:**
61+
5862
- Once your PR is approved and merged, your contribution shall be immortalized within the project.
5963

64+
65+
6066
## Code of Conduct 🤝
6167

6268
Please be aware that we uphold a [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a positive and respectful environment for all contributors. As a participant in this project, you pledge to abide by the Code of Conduct.
6369

70+
71+
6472
Let's embark on this collective journey to create a precious resource for developers. Thank you for adding your spark to "You Don't Need JavaScript!" ⚡🌟

0 commit comments

Comments
 (0)