Skip to content

Changes in the contributing guidelines to improve onboarding #31

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Changes in the contributing guidelines to improve onboarding #31

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0eeb11
Update the contribution types
benjagm Dec 27, 2024
91d7836
Add more contribution types.
benjagm Dec 27, 2024
e103571
fix typo
benjagm Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,27 @@ Here are some areas where you can contribute:
* 🐞 Reporting Bugs
* 💡 Issues and feature requests
* ✅ JSON Schema [Test Suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite) development
* 🔗 [Bowtie](https://github.com/bowtie-json-schema/bowtie) development
* 🧐 Reviewing PRs
* ❓ Answer questions
* 🙏 Join discussions and provide feedback
* 🛠️ [Add new JSON Schema tooling](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#%EF%B8%8F-add-a-new-implementation)
* 🚀 [Adding a new Adopter](https://github.com/json-schema-org/community/blob/main/ADOPTERS.md)
* ✍️ [Publish a blog post](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#%EF%B8%8F-publish-a-blog-post)
* 📈 [Publish a case study](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-publish-a-case-study)
* 📋 [Improving The Documentation](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-documentation)
* 🏗 [Website development](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-website)
* 🎨 [Improving The Design](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-design)
* 😍 [Collaborating with Community Management tasks](https://github.com/json-schema-org/community)
* 🚀 [Adding a new Adopter](https://github.com/json-schema-org/community/blob/main/ADOPTERS.md)
* 🌈 Other JSON Schema projects you can contribute to:
* [JSON Schema Conference](https://github.com/json-schema-org/conference/blob/main/CONTRIBUTING.md).
* [Tour of JSON Schema](https://github.com/json-schema-org/tour/blob/main/CONTRIBUTING.md).
* [JSON Schema Landscape](https://github.com/json-schema-org/landscape/blob/main/CONTRIBUTING.md).
* [JSON Schema Ecosystem](https://github.com/json-schema-org/ecosystem).
Copy link

@Honyii Honyii Dec 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link for JSON Schema Ecosystem should follow the format for the other projects i.e referencing the contributing.md file "https://github.com/json-schema-org/landscape/blob/main/CONTRIBUTING.md" OR if there's a reason why we are referencing "https://github.com/json-schema-org/ecosystem", then this implementation is okay.


* 🌐 Other JSON Schema Ecosystem Projects you can contribute to:
* [Bowtie](https://github.com/bowtie-json-schema/bowtie) development
Copy link
Member

@gregsdennis gregsdennis Dec 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we calling out bowtie specifically but only referring to (and also not linking to) "other tools"?

Copy link
Collaborator Author

@benjagm benjagm Jan 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we calling out bowtie specifically but only referring to (and also not linking to) "other tools"?

That is a great question. I have been pushing for a standard agreement about reaching a common understanding of what means "critical JSON Schema projects" and what those are, but the issue with that discussion is still ongoing json-schema-org/TSC#5. Happy to add here other critical projects like alterschema.

In terms of implementations, that is a different story because, as of now, we have been neutral, avoiding promoting certain implementations over others. However, we could create a way for implementers to communicate that they seek new contributors by adding a new field to the tooling metadata.

* Contribute to any well mantained JSON Schema implementation.



## Key "Architectural" decisions
Expand Down
1 change: 1 addition & 0 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Here are some areas where you can contribute:
* Website development
* Community
* Adopters
* Other projects you can contribute to: Conference, Landscape, Tour of JSON Schema and Ecosystem.

Please check out our [Contribution guidelines](https://github.com/json-schema-org/.github/blob/main/CONTRIBUTING.md) to know more about how to contribute in each area.

Expand Down
Loading