Skip to content

Commit 6cfa53f

Browse files
committed
add docs CONTRIBUTING guide
1 parent 7807031 commit 6cfa53f

File tree

3 files changed

+84
-19
lines changed

3 files changed

+84
-19
lines changed

pages/contributions/CONTRIBUTING.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: Contributing to the JSON Schema documentation
3+
section: docs
4+
---
5+
6+
## Welcome
7+
8+
Welcome to the JSON Schema Contributing Guide, and thank you for your interest.
9+
10+
This guide will help you get started with the basics of our documentation working processes.
11+
12+
## Ground rules
13+
14+
Before working on any contribution, we ask our members to [read our Code of Conduct](../contributions/code-of-conduct) to learn more about our values, behavioral expectations, standards, and rules.
15+
16+
## Before you start
17+
18+
To contribute to the JSON Schema documentation you will need to complete the following steps:
19+
20+
1. [Create a GitHub account](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github#signing-up-for-a-new-personal-account), if you don't have one already.
21+
2. Read and agree to our Code of Conduct.
22+
3. [Install Node.js v20.9.0+](https://nodejs.org/en/download/package-manager).
23+
4. [Set up environment variables](https://github.com/json-schema-org/website?tab=readme-ov-file#setup-enviroment-variables), like yarn.
24+
25+
## Community engagement
26+
27+
To stay updated with news about the JSON Schema project and its documentation, engage with our team, ask questions, and discuss ideas, please [join our Slack workspace](https://json-schema.org/slack) and the following channels:
28+
29+
**#documentation**: Discuss anything related to the JSON Schema documentation.
30+
31+
**#community-announcements**: Announce events related to the JSON Schema project and share updates.
32+
33+
**#anouncements**: This is reserved to announcements from the JSON Schema organization.
34+
35+
**#website**: Discuss things related to our website.
36+
37+
**#introductions**: Introduce yourself to the community and get to know other members.
38+
39+
To learn about what our readers are discussing and their questions about the JSON Schema, we recommend joining the **#stack-overflow** channel, which contains Stack overflow questions tagged with JSON Schema.
40+
41+
42+
## Best practices
43+
44+
This is a list of best practices the JSON Schema project strives and resources we recommend for additional information:
45+
46+
1. Markdown syntax: Use this [Markdown cheat sheet](https://www.markdownguide.org/cheat-sheet/) for a wuick reference.
47+
2. File naming conventions: We use dashes instead of spaces, and lowercase letters to name .md files. For example: **contributing-guide.md**
48+
3. Commit messages: We recommend reading this comprehensive [step-by-step guide on how to write good commit messages on Git](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/).
49+
4. Style guide: We follow the [Google developer documentation style guide](https://developers.google.com/style).
50+
51+
## Contribution workflow
52+
We value documentation and appreciate efforts to help us improve our documents. There are two ways you can contribute to improve our documentation:
53+
54+
55+
1. Work on an existing issue.
56+
2. Propose changes.
57+
58+
### Work on an existing issue
59+
60+
To work on an existing issue, go to the [JSON Schema docs board](https://github.com/orgs/json-schema-org/projects/16), where you will find all the open issues related to documentation.
61+
62+
If the issue you select has no asignees, you can claim the issue by leaving a comment on it and tagging @benjagm who will asignt the issue to you.
63+
64+
If the issue you select has an asignee already, express your interest in collaborating and tag the asignee instead in the comment. The JSON Schema respects the order in which people claim issues, therefore, you will have to check if the asignee is accepting collaborations.
65+
66+
After you have been assigned to an issue, [fork the json-schema-org/website repository](https://github.com/json-schema-org/website) and create a new branch to work on your changes.
67+
68+
### Propose changes
69+
70+
To propose modifications to our documentation, we invite you to first review our [documentation board](https://github.com/orgs/json-schema-org/projects/16) and make sure no issue has been created for the changes you're proposing.
71+
72+
If no issue exists, you can [create a GitHub issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-repository) and select the *Documentation* template. After you create the issue, you can decide whether you want to work on it yourself or let someone else claim it. For working on the issue yourself, tag @benjagm in the comment so he assigns you to it. To work on the changes.
73+
74+
![Screenshot of available issue templates and a yellow arrow pointing at the Dcoumentation template](../contributions/documentation-template-screenshot.png)
75+
76+
## Create a Pull Request
77+
78+
To work on your changes, fork the [json-schema-org/website repository](https://github.com/json-schema-org/website) and create a new branch. Use dashes (-) instead of spaces when naming your branch. When your changes are ready for review, open a pull request to the main branch, and add the issue your pull request solves. Add @benjagm as reviewers and leave a comment asking for a review.
79+
80+
After your pull request is reviewed by the community and is approved, you will merge your changes into the main branch and your contribution to the project will be complete!
81+
82+
We created this guide based on templates from [The Good Docs Project](https://www.thegooddocsproject.dev/).
83+
84+

pages/contributions/contributions.md

Lines changed: 0 additions & 19 deletions
This file was deleted.
Loading

0 commit comments

Comments
 (0)