Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[📝 Docs]: Enhance the Contribution Docs Guide for Better Readability and Structure #1124

Open
1 task done
fee-sah-yor opened this issue Nov 18, 2024 · 1 comment
Open
1 task done
Assignees
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@fee-sah-yor
Copy link

fee-sah-yor commented Nov 18, 2024

What Docs changes are you proposing?

Description:

Hi, I read through the contribution guide and noticed that some parts of the introduction can be a bit confusing, especially for beginners. I found myself rereading certain sections multiple times to fully understand the process. Here are a few suggestions to improve the guide’s clarity:

  1. Reorder Items in "Before You Start":

    • I suggest moving "Read the style guide" to the third item in the "Before You Start" list. This way, beginners can go through the style guide first, and then proceed to fork the JSON schema repo. This feels more intuitive.
      Reword Installation Instructions:
  2. Reword Installation Instructions:

    • The line "Install the JSON schema website on your computer" could be rephrased to:
      "Fork the repo and follow these steps to install the JSON schema website on your computer."
      This change better reflects the steps outlined later in the guide, particularly in the "Work on an Existing Issue" section.
  3. Format the "Work on an Existing Issue" Section:

    • The instructions in this section could be formatted as a bulleted list with indented steps for better readability. It’s currently harder to follow as a block of text.

i believe these changes as well as others will help beginner contributors interacting with the guide for the first time understand it better.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@fee-sah-yor fee-sah-yor added Status: Triage This is the initial status for an issue that requires triage. 📝 Documentation Indicates improvements or additions to documentation. labels Nov 18, 2024
Copy link

Welcome to the JSON Schema Community. We are so excited you are here! Thanks a lot for reporting your first issue!! 🎉🎉 Please make sure to take a look at our contributors guide if you plan on opening a pull request.
For more details, check out the README.md file.

@valeriahhdez valeriahhdez added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Triage This is the initial status for an issue that requires triage. labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

No branches or pull requests

2 participants