Skip to content

Commit d365425

Browse files
authored
Merge pull request #538 from json-schema-org/benjagm-contributing-exp
Issue to review the contributing document and add a triage process proposal
2 parents f7d1ca1 + 7ed8296 commit d365425

File tree

4 files changed

+145
-32
lines changed

4 files changed

+145
-32
lines changed

COMMUNITY-MANAGER.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Community Manager Role
2+
3+
Community managers are responsible for managing many aspects of the JSON Schema community. The goal is to achieve and maintain a healthy and growing JSON Schema community where everyone feels welcome and is encouraged to share knowledge and learn from each other. This document outlines the responsibilities of a community manager and the process involved in becoming one.
4+
5+
### Responsibilities
6+
7+
A community manager has the following responsibilities:
8+
9+
* Manage the JSON Schema Open Community Working Meetings:
10+
* Host the call.
11+
* Publish the community call recording to the YouTube channel.
12+
* Manage the Slack community:
13+
* Organize and monitor Slack channels.
14+
* Ensure community rules are being followed.
15+
* Help new Slack users find the right channels & answers.
16+
* Announce JSON Schema updates and events.
17+
* Review issues & pull requests in the community repository.
18+
* Review and publish JSON Schema blog posts submitted by the community.
19+
* Report on community health, growth trends, and top issues to maintainers and STC.
20+
* Propose new partnerships with other adjacent communities to STC and manage them.
21+
* Manage community analytics tools, including Plausible and CommonRoom.io.
22+
* Manage the social media accounts: [@jsonschema](https://twitter.com/jsonschema) Twitter and [@jsonschema](https://twitter.com/jsonschema) and [@jsonschema](https://www.linkedin.com/company/jsonschema) Linkedin:
23+
* Asking the community for community call topics.
24+
* Announcing community calls (one day before and one hour before the call).
25+
* Announcing that the recording of the community call is available on YouTube.
26+
* Announcing JSON Schema updates like tooling or adopters.
27+
* Announcing new JSON Schema blog posts.
28+
* Reposting relevant tweets from the community.
29+
* Manage the [@JSONSchemaOrgOfficial](https://www.youtube.com/@JSONSchemaOrgOfficial) YouTube account.
30+
* Launch and manage Community programs.
31+
32+
### Duties that require STC approval
33+
34+
* Add new analytics tools
35+
36+
### Know more
37+
38+
Please join the `#community-mgmt` slack channel using this [link](#community-mgmt) if you like to know more.
39+
40+
### Atribution
41+
42+
This document has been inspared by the [DAPR Community Manager document](https://github.com/dapr/community/blob/master/COMMUNITY-MANAGER.md).

CONTRIBUTING.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,34 @@
1-
# Guidelines for contributing to the JSON Schema project GitHub organisation
2-
3-
🚨 Work in progress! (2021/07 - @relequestual)
1+
# Guidelines for contributing to the JSON Schema Community
42

53
We invite you to join us working on JSON Schema.
64

7-
The fastest way to get involved and become active in the community is to join our Slack server at https://json-schema.org/slack.
5+
The fastest way to get involved and become active in the community is to join the `#contribute` channel in our Slack server at https://json-schema.org/slack.
86

97
If you have suggestions on how to improve our community, please do check out our [Community Discussions](https://github.com/json-schema-org/community/discussions), and start a new discussion.
108

11-
# General
9+
### Types of contributions
10+
11+
JSON Schema is a community that lives on its contributors. As we grow, we need more people to help others. You can contribute in many ways, either in the specification development or in the wider ecosystem.
12+
13+
Here are some areas where you can contribute:
14+
* 🌱 [Specification development](https://github.com/json-schema-org/json-schema-spec)
15+
* 🐞 Reporting Bugs
16+
* 💡 Issues and feature requests
17+
* 🧐 Reviewing PRs
18+
* ❓ Answer questions
19+
* 🙏 Join discussions and provide feedback
20+
* 🛠️ [Add new JSON Schema tooling](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#%EF%B8%8F-add-a-new-implementation)
21+
* ✍️ [Publish a blog post](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#%EF%B8%8F-publish-a-blog-post)
22+
* 📈 [Publish a case study](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-publish-a-case-study)
23+
* 📋 [Improving The Documentation](https://github.com/orgs/json-schema-org/projects/16)
24+
* 🏗 [Website development](https://github.com/orgs/json-schema-org/projects/11/views/1)
25+
* 🎨 [Improving The Design](https://github.com/json-schema-org/website/blob/main/CONTRIBUTING.md#-improving-the-design)
26+
* 😍 [Collaborating with Community Management tasks](#community-management-tasks)
27+
* 🚀 [Adding a new Adopter](https://github.com/json-schema-org/community/blob/main/ADOPTERS.md)
1228

13-
While each repository may have its own guidance for contributing, the following sections apply organisation wide.
29+
#### Community management tasks
30+
31+
To get involved in the Community management tasks, please join the [`#community-mgmt` slack channel](https://json-schema.slack.com/archives/C0209BTU2UQ).
1432

1533
## Key "Architectural" decisions
1634

@@ -45,6 +63,10 @@ Once an ADR is part of a pull request which is labelled with `adr-required`, the
4563

4664
The process is designed to be lightweight, and a template is provided for ease of use.
4765

66+
### Triage
67+
68+
Please check the [triage process](https://github.com/json-schema-org/.github/blob/main/TRIAGE.md) to learn how we review and label incoming issues .
69+
4870
### Feedback
4971

5072
Feedback on this process can be made informally through our [Slack server](https://json-schema.org/slack) and formally using our [Community Discussions](https://github.com/json-schema-org/community/discussions).

README.md

Lines changed: 74 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,97 @@
1-
# JSON Schema Community
1+
[![JSON Schema logo - Build more, break less, empower others.](https://raw.githubusercontent.com/json-schema-org/.github/main/assets/json-schema-banner.png)](https://json-schema.org)
2+
3+
<br/>
4+
<p>
5+
<a href="https://github.com/json-schema-org/website/graphs/contributors" alt="JSON Schema GitHub website contributors">
6+
<img src="https://img.shields.io/github/contributors/json-schema-org/website?color=orange" />
7+
</a>
8+
<a href="https://github.com/json-schema-org/website/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22" alt="Good First JSON Schema issue">
9+
<img src="https://img.shields.io/github/issues/json-schema-org/website/good%20first%20issue.svg?color=%23DDDD00" />
10+
</a>
11+
<a href="https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md" alt="Contributor Covenant">
12+
<img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" />
13+
</a>
14+
<a href="https://www.repostatus.org/#active" alt="Repo status">
15+
<img src="https://www.repostatus.org/badges/latest/active.svg" />
16+
</a>
17+
<a href="https://github.com/json-schema-org/community/discussions" alt="Discussions">
18+
<img src="https://img.shields.io/github/discussions/json-schema-org/community" />
19+
</a>
20+
<a href="https://opencollective.com/json-schema" alt="Financial Contributors on Open Collective">
21+
<img src="https://opencollective.com/json-schema/all/badge.svg?label=financial+contributors" />
22+
</a>
23+
<a href="https://adr.github.io" alt="part of ADR">
24+
<img src="https://img.shields.io/badge/part_of-ADR-blue" />
25+
</a>
26+
<a href="https://json-schema.org/slack" alt="JSON Schema Slack">
27+
<img src="https://img.shields.io/badge/[email protected]?logo=slack&color=yellow" />
28+
</a>
29+
</p>
230

3-
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md)
4-
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
5-
[![Financial Contributors on Open Collective](https://opencollective.com/json-schema/all/badge.svg?label=financial+contributors)](https://opencollective.com/json-schema)
31+
# JSON Schema Community
632

7-
[![part of ADR](https://img.shields.io/badge/part_of-ADR-blue)](https://adr.github.io)
8-
![GitHub Discussions](https://img.shields.io/github/discussions/json-schema-org/community)
33+
Welcome to the JSON Schema community! You've arrived at the perfect place to begin your journey as a contributor. Whether it's assisting with documentation, writing a blog post, enhancing the website, delivering presentations, or any other form of contribution, there's plenty of opportunities to get involved in the project. We are a friendly, collaborative group and look forward to working together.
934

10-
# What is this repo?
35+
- 👋 [Introduction](#introduction)
36+
- 💬 [Discussions and slack](#discussions-and-slack)
37+
- 🗓 [Community meetings](#community-meetings)
38+
- 🌱 [Getting involved](#getting-involved)
1139

40+
## Introduction
1241
This repo is a place to discuss and debate various aspects of running the JSON Schema organisation, how we work as a community, and our expectations.
1342

14-
The discussions will primarily take place using [Github Discussions](https://github.com/json-schema-org/community/discussions) for this repo.
43+
### Discussions and Slack
44+
45+
Reach out with any questions you may have and we'll make sure to answer them as soon as possible and as a community member feel free to jump in and answer questions.
46+
47+
JSON Schema utilizes Slack and GitHub Discussions to facilitate our communications, each serving unique purposes to support our community effectively.
48+
49+
Slack is the go-to for lively conversations, channel announcements, one-on-one support, and immediate assistance, making real-time communication seamless and efficient. However, Slack isn't ideal for housing detailed discussions, long-term planning, or tracking the evolution of ideas and decisions.
50+
51+
For more in-depth discussions, planning, and documenting significant decisions, we use GitHub Discussions. It allows us to work together on significant decisions more effectively and provides long standing point of reference for our discussions.
1552

16-
Initially Github issues will be disabled as we evaluate how we should use them in this repo (through Discussions).
53+
| Platforms | Link |
54+
|:----------|:-------------|
55+
| 💬 Slack (preferred) | https://json-schema.org/slack
56+
| 💬 Discussions | https://github.com/orgs/json-schema-org/discussions
1757

18-
Once we have some links for the community, this readme will link to various locations, resources, and documents that are useful for the community.
58+
### Community meetings
59+
We hold monthly Office Hours and weekly Open Community Working Meetings. Office Hours are every first Tuesday of the month at 15:00 BST, and by appointment. Open Community Working Meetings are every Monday at 14:00 PT.
1960

20-
# Who can use this repo?
61+
**Office Hours (Monthly):**
2162

22-
Anyone who wants to learn about, be part of, or help improve the JSON Schema community is welcome here.
63+
**Office Hours** provide time for the community for questions, discussions, comments, or just to chat about JSON Schema.
2364

24-
Anyone can start a discussion in any category. You can even start a discussion to suggest adding a new category!
65+
More details [here](https://github.com/orgs/json-schema-org/discussions/34/).
2566

26-
# Why do we need this repo to have discussions?
67+
**Open Community Working Meeting (Weekly):**
2768

28-
Slack is really great for chatting, working through tricky problems, having one-to-one support sessions.
69+
**Open Community Working Meetings** are a 1 hour, agenda'd only, with a focus on furthering the JSON Schema specification and organization.
2970

30-
Slack is not so great for long running ideas, plans, or discussions, a point of reference for decisions, keeping a log of progress.
71+
More details [here](https://github.com/orgs/json-schema-org/discussions/35).
3172

32-
Using Github Discussions, we can collaborate on important decisions over a longer period of time and have a long standing point of reference
73+
You can always catch up offline by watching the recordings on the JSON Schema YouTube channel.
3374

34-
# Why not just use Github Issues?
75+
| Asset | Link |
76+
|:-----------|:------------|
77+
| 🔗 Office Hours Meeting Link | [**Zoom Link**](https://postman.zoom.us/j/85358817067?pwd=NmFXTG5oL1paK0VyTEdrNU9TR2RMUT09)<br>
78+
| 🔗 Open Community Working Meeting Link | [**Zoom Link**](https://www.google.com/url?q=https://postman.zoom.us/j/89562933116?pwd%3DOWlsQ0RrcDY4S1JQU2d2Q2M0aFFlZz09&sa=D&source=calendar&ust=1708431911262691&usg=AOvVaw14JoRXk9cLLBT-_wngWROA)<br>
79+
| 🎥 Meeting Recordings | https://www.youtube.com/@JSONSchemaOrgOfficial
3580

36-
Github Issues are great for getting work done, but not so great at having threaded debates and discussions.
81+
## Getting involved
3782

38-
Picking to use Github Discussions before creating an issue allows us to seek consensus in discussion and keep Issues as the space for tracking work product and its progress.
83+
JSON Schema is a community that lives on its contributors. As we grow, we need more people to help others. Do you like to get involved? You can contribute in many ways!
3984

40-
# Who decided all this? Is it up for debate?
85+
Please check out our [Contribution guidelines](CONTRIBUTING.md) to know more.
4186

42-
Ben Hutton (@relequestual) created this repo and initial readme on April 2021, based on the expectations of community and organisational needs having grown, supported, and observed the community over the past 5 years.
87+
### Contributors
4388

44-
**None of this is set in stone. Humans are fallible. Everything is up for debate.**
89+
Thanks goes to these wonderful people who contributed to this communtiy space:
90+
<a href = "https://github.com/json-schema-org/community/graphs/contributors">
91+
<img src = "https://contrib.rocks/image?repo=json-schema-org/community"/>
92+
</a>
4593

46-
While Ben has become the self-appointed core team lead at some point during those 5 years, we strive to work on a model of general consensus, which works well for specification development, and is something we rely on to move us forward.
94+
<sub>Made with [contributors-img](https://contrib.rocks).</sub>
4795

48-
Ben acts in several ways as an executive for the organisation, and feels trusted enough to make organisational decisions like this with the expectation of change and with as much transparency as possible.
96+
## Code of Conduct
97+
To get involved with our Community, please make sure you are familiar with our [Code of Conduct](https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md).

docs/blog-guidelines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## JSON Schema Blog Overview ##
44

5-
The JSON Schema blog serves as a channel for JSON Schema maintainers and contributors, implementation maintainers, and [Community Champions](#note-on-json-champions) to share content with the JSON Schema Community.
5+
[The JSON Schema blog](https://json-schema.org/blog) serves as a channel for project maintainers and contributors, implementation maintainers, and JSON Schema Champions to share content with the JSON Schema Community.
66

77
The content on our blog consists of:
88
* Use cases and success stories

0 commit comments

Comments
 (0)