Skip to content

Commit 441fcb4

Browse files
committed
docs: add contributing section to README with guidelines for contributions
1 parent 2b811e0 commit 441fcb4

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Welcome to the **Tour of JSON Schema** project! This repository hosts the codeba
1111
- [Development Setup](#development-setup)
1212
- [Prerequisites](#prerequisites)
1313
- [Installation](#installation)
14+
- [Contributing](#contributing)
1415
- [Content Creation](#content-creation)
1516
- [Writing MDX](#writing-mdx)
1617
- [VSCode Extensions](#vscode-extensions)
@@ -19,7 +20,6 @@ Welcome to the **Tour of JSON Schema** project! This repository hosts the codeba
1920
- [GoodToKnowBox](#goodtoknowbox)
2021
- [CodeSnippet](#codesnippet)
2122
- [SideEditorLink](#sideeditorlink)
22-
- [Contributing](#contributing)
2323

2424
---
2525

@@ -56,6 +56,14 @@ The project is built using **Next.js**, a React framework for building server-re
5656
```bash
5757
pnpm test
5858
```
59+
> [!NOTE]
60+
> Always run tests before submitting a pull request to ensure your changes do not introduce regressions.
61+
62+
63+
### Contributing
64+
65+
Please Read the [Contributing Guide](CONTRIBUTING.md) for detailed instructions on how to contribute to the project.
66+
5967

6068
---
6169

@@ -165,22 +173,6 @@ A link that focuses the editor on the right side of the screen.
165173
```md
166174
<SideEditorLink text="Open the editor to try this example" />
167175
```
168-
169-
---
170-
171-
## Contributing
172-
173-
We welcome contributions from the community! If you'd like to contribute, please follow these guidelines:
174-
175-
1. Fork the repository and create a new branch for your changes.
176-
2. Ensure your changes pass all tests by running:
177-
```bash
178-
pnpm test
179-
```
180-
3. Submit a pull request with a detailed description of your changes.
181-
182-
> **Note**: Always run tests before submitting a pull request to ensure your changes do not introduce regressions.
183-
184176
---
185177

186178
Thank you for contributing to the **Tour of JSON Schema** project! Together, we can make JSON Schema more accessible and easier to learn for everyone.

0 commit comments

Comments
 (0)