From 4cf6a4785b7a954c78235545db6817b76553b27a Mon Sep 17 00:00:00 2001 From: Fran Mendez Date: Thu, 22 Feb 2024 21:42:08 +0100 Subject: [PATCH 1/8] docs: add info about working groups --- WORKING_GROUPS.md | 17 +++++++++++++++++ WORKING_GROUPS.yaml | 11 +++++++++++ 2 files changed, 28 insertions(+) create mode 100644 WORKING_GROUPS.md create mode 100644 WORKING_GROUPS.yaml diff --git a/WORKING_GROUPS.md b/WORKING_GROUPS.md new file mode 100644 index 000000000..0f924afe4 --- /dev/null +++ b/WORKING_GROUPS.md @@ -0,0 +1,17 @@ +### Definition of a working group + +A working group is a group of people in our community who share a common interest beyond GitHub repositories. + +A working group must have, at least, one of its members appointed as its chairperson. + +Anyone can create a working group. The only prerequisites are to have at least 3 founding members and the approval of the TSC (Technical Steering Committee). + +A working group should have its own set of goals or objectives. This helps everyone in the working group to stay aligned. The goals must be public and easily accessible by anyone on the internet. + +It's recommended that a working group has an associated [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project) project (or any other project management tool) where the group outlines their roadmap. It's up to the Working Group to decide the structure of the project. E.g., Kanban, Shape Up, TO-DO list, etc. + +The name of the group, its members, the goals, and any other relevant information must be listed in the WORKING_GROUPS.yaml file in the `community` repository. + +A working group has no decision power over the roadmap of the projects they may impact. It's up to the maintainers (code owners) of the repositories involved to approve or reject the resulting pull requests. Therefore, it's highly recommended to either have maintainers of the impacted projects in the working group or make sure everyone is in agreement before deciding about the roadmap of the different repositories/projects. + +Working groups should be listed in the AsyncAPI website (asyncapi.com and asyncapi.org), along with their description, goals, members, an anything the working group wants to include. \ No newline at end of file diff --git a/WORKING_GROUPS.yaml b/WORKING_GROUPS.yaml new file mode 100644 index 000000000..55e32ba5a --- /dev/null +++ b/WORKING_GROUPS.yaml @@ -0,0 +1,11 @@ +# This file contains the list of the currently active working groups. +# +# To learn more about working groups, read the WORKING_GROUPS.md file. + +working_groups: + # - name: The name of the working group + # description: Describe what this working group is about. + # chairperson: @Barbanio # GitHub handle of the chairperson. + # members: + # - @fmvilas # GitHub handle of the member. + # roadmap_url: https://example.com/xyz # Link to a GitHub project, issue, or any other tool where the Working Group outlines their roadmap. From 4de152894dd425c871aa3139844f0e0acf14052e Mon Sep 17 00:00:00 2001 From: Fran Mendez Date: Thu, 22 Feb 2024 21:45:38 +0100 Subject: [PATCH 2/8] Add info about OKRs --- WORKING_GROUPS.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/WORKING_GROUPS.yaml b/WORKING_GROUPS.yaml index 55e32ba5a..d48e7a85c 100644 --- a/WORKING_GROUPS.yaml +++ b/WORKING_GROUPS.yaml @@ -8,4 +8,5 @@ working_groups: # chairperson: @Barbanio # GitHub handle of the chairperson. # members: # - @fmvilas # GitHub handle of the member. + # okrs_url: https://example.com/xyz # Link to a GitHub project, issue, or any other tool where the Working Group explains their objectives. # roadmap_url: https://example.com/xyz # Link to a GitHub project, issue, or any other tool where the Working Group outlines their roadmap. From be53491cb7bd94f535bd8c3eb0e4d7ba025bc317 Mon Sep 17 00:00:00 2001 From: Fran Mendez Date: Thu, 22 Feb 2024 21:47:31 +0100 Subject: [PATCH 3/8] Differentiate required and recommended fields --- WORKING_GROUPS.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/WORKING_GROUPS.yaml b/WORKING_GROUPS.yaml index d48e7a85c..350942e64 100644 --- a/WORKING_GROUPS.yaml +++ b/WORKING_GROUPS.yaml @@ -3,10 +3,10 @@ # To learn more about working groups, read the WORKING_GROUPS.md file. working_groups: - # - name: The name of the working group - # description: Describe what this working group is about. - # chairperson: @Barbanio # GitHub handle of the chairperson. - # members: + # - name: Required. The name of the working group. + # description: Required. Describe what this working group is about. + # chairperson: Required. GitHub handle of the chairperson. Example: @Barbanio. + # members: # Required to have at least 2 members who are not the same as the chairperson. # - @fmvilas # GitHub handle of the member. - # okrs_url: https://example.com/xyz # Link to a GitHub project, issue, or any other tool where the Working Group explains their objectives. - # roadmap_url: https://example.com/xyz # Link to a GitHub project, issue, or any other tool where the Working Group outlines their roadmap. + # okrs_url: https://example.com/xyz # Required. Link to a GitHub project, issue, or any other tool where the Working Group explains their objectives. + # roadmap_url: https://example.com/xyz # Recommended. Link to a GitHub project, issue, or any other tool where the Working Group outlines their roadmap. From fd96ce3179abd85efaa32890eba083204533a1be Mon Sep 17 00:00:00 2001 From: Fran Mendez Date: Fri, 23 Feb 2024 10:18:31 +0100 Subject: [PATCH 4/8] Add slack channel and github team --- WORKING_GROUPS.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/WORKING_GROUPS.yaml b/WORKING_GROUPS.yaml index 350942e64..f1dffe431 100644 --- a/WORKING_GROUPS.yaml +++ b/WORKING_GROUPS.yaml @@ -8,5 +8,7 @@ working_groups: # chairperson: Required. GitHub handle of the chairperson. Example: @Barbanio. # members: # Required to have at least 2 members who are not the same as the chairperson. # - @fmvilas # GitHub handle of the member. + # slack_channel: # Required. The name of the Slack channel in the AsyncAPI workspace. Example: community_growth_wg # okrs_url: https://example.com/xyz # Required. Link to a GitHub project, issue, or any other tool where the Working Group explains their objectives. # roadmap_url: https://example.com/xyz # Recommended. Link to a GitHub project, issue, or any other tool where the Working Group outlines their roadmap. + # github_team: # Recommended. The GitHub team handle to tag all the working group members at once. Example: @asyncapi/community_growth_wg. From 0e508af6df465e4d730685a04273ba437670cb49 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Tue, 27 Feb 2024 14:16:50 +0200 Subject: [PATCH 5/8] add minor grammar changes --- WORKING_GROUPS.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/WORKING_GROUPS.md b/WORKING_GROUPS.md index 0f924afe4..c821486b2 100644 --- a/WORKING_GROUPS.md +++ b/WORKING_GROUPS.md @@ -1,17 +1,17 @@ -### Definition of a working group +### Definition of a Working Group -A working group is a group of people in our community who share a common interest beyond GitHub repositories. +A `Working Group` is a group of people in our community who share a common interest beyond GitHub repositories. -A working group must have, at least, one of its members appointed as its chairperson. +A `Working Group` must have at least one of its members appointed as its chairperson. -Anyone can create a working group. The only prerequisites are to have at least 3 founding members and the approval of the TSC (Technical Steering Committee). +Anyone can create a `Working Group`. The only prerequisites are to have at least 3 founding members and the approval of the TSC (Technical Steering Committee). -A working group should have its own set of goals or objectives. This helps everyone in the working group to stay aligned. The goals must be public and easily accessible by anyone on the internet. +A `Working Group` should have clearly defined goals that are easily accessible to everyone on the internet, as this helps maintain alignment within the group. -It's recommended that a working group has an associated [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project) project (or any other project management tool) where the group outlines their roadmap. It's up to the Working Group to decide the structure of the project. E.g., Kanban, Shape Up, TO-DO list, etc. +The `Working Group` should have an associated project management tool like [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project) (or any other project management tool) to outline their roadmap. It's up to the `Working Group` to decide the structure of the project. E.g., Kanban, Shape Up, TO-DO list, etc. -The name of the group, its members, the goals, and any other relevant information must be listed in the WORKING_GROUPS.yaml file in the `community` repository. +The group's name, members, goals, and other relevant information must be added to the `WORKING_GROUPS.yaml` file in the `community` repository. -A working group has no decision power over the roadmap of the projects they may impact. It's up to the maintainers (code owners) of the repositories involved to approve or reject the resulting pull requests. Therefore, it's highly recommended to either have maintainers of the impacted projects in the working group or make sure everyone is in agreement before deciding about the roadmap of the different repositories/projects. +A `Working Group` has no authority or power over the roadmap of the projects they may impact. It's up to the repositories' maintainers (code owners) to approve or reject the pull requests. Therefore, it's advisable to either have maintainers of the impacted projects in the `Working Group` or ensure everyone agrees on the roadmap of the different repositories/projects. -Working groups should be listed in the AsyncAPI website (asyncapi.com and asyncapi.org), along with their description, goals, members, an anything the working group wants to include. \ No newline at end of file +`Working Groups` should be listed on the AsyncAPI website (asyncapi.com and asyncapi.org), along with their description, goals, members, and anything the `Working Group` wants to include. From ab85283281b4c0770ee673a4cb111145fc90462f Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Tue, 27 Feb 2024 14:20:00 +0200 Subject: [PATCH 6/8] remove unnecessary punctuations --- WORKING_GROUPS.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/WORKING_GROUPS.md b/WORKING_GROUPS.md index c821486b2..78749c8e6 100644 --- a/WORKING_GROUPS.md +++ b/WORKING_GROUPS.md @@ -1,17 +1,17 @@ ### Definition of a Working Group -A `Working Group` is a group of people in our community who share a common interest beyond GitHub repositories. +A Working Group is a group of people in our community who share a common interest beyond GitHub repositories. -A `Working Group` must have at least one of its members appointed as its chairperson. +A Working Group must have at least one of its members appointed as its chairperson. -Anyone can create a `Working Group`. The only prerequisites are to have at least 3 founding members and the approval of the TSC (Technical Steering Committee). +Anyone can create a Working Group. The only prerequisites are to have at least 3 founding members and the approval of the TSC (Technical Steering Committee). -A `Working Group` should have clearly defined goals that are easily accessible to everyone on the internet, as this helps maintain alignment within the group. +A Working Group should have clearly defined goals that are easily accessible to everyone on the internet, as this helps maintain alignment within the group. -The `Working Group` should have an associated project management tool like [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project) (or any other project management tool) to outline their roadmap. It's up to the `Working Group` to decide the structure of the project. E.g., Kanban, Shape Up, TO-DO list, etc. +The Working Group should have an associated project management tool like [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project) (or any other project management tool) to outline their roadmap. It's up to the Working Group to decide the structure of the project. E.g., Kanban, Shape Up, TO-DO list, etc. The group's name, members, goals, and other relevant information must be added to the `WORKING_GROUPS.yaml` file in the `community` repository. -A `Working Group` has no authority or power over the roadmap of the projects they may impact. It's up to the repositories' maintainers (code owners) to approve or reject the pull requests. Therefore, it's advisable to either have maintainers of the impacted projects in the `Working Group` or ensure everyone agrees on the roadmap of the different repositories/projects. +A Working Group has no authority or power over the roadmap of the projects they may impact. It's up to the repositories' maintainers (code owners) to approve or reject the pull requests. Therefore, it's advisable to either have maintainers of the impacted projects in the `Working Group` or ensure everyone agrees on the roadmap of the different repositories/projects. -`Working Groups` should be listed on the AsyncAPI website (asyncapi.com and asyncapi.org), along with their description, goals, members, and anything the `Working Group` wants to include. +Working Groups should be listed on the AsyncAPI website (asyncapi.com and asyncapi.org), along with their description, goals, members, and anything the Working Group wants to include. From 80e630f176945f6a3bddfcad7b8118e1ff6bc630 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Tue, 27 Feb 2024 14:23:46 +0200 Subject: [PATCH 7/8] add website url --- WORKING_GROUPS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/WORKING_GROUPS.md b/WORKING_GROUPS.md index 78749c8e6..3ae469ed3 100644 --- a/WORKING_GROUPS.md +++ b/WORKING_GROUPS.md @@ -12,6 +12,6 @@ The Working Group should have an associated project management tool like [GitHub The group's name, members, goals, and other relevant information must be added to the `WORKING_GROUPS.yaml` file in the `community` repository. -A Working Group has no authority or power over the roadmap of the projects they may impact. It's up to the repositories' maintainers (code owners) to approve or reject the pull requests. Therefore, it's advisable to either have maintainers of the impacted projects in the `Working Group` or ensure everyone agrees on the roadmap of the different repositories/projects. +A Working Group has no authority or power over the roadmap of the projects they may impact. It's up to the repositories' maintainers (code owners) to approve or reject the pull requests. Therefore, it's advisable to either have maintainers of the impacted projects in the Working Group or ensure everyone agrees on the roadmap of the different repositories/projects. -Working Groups should be listed on the AsyncAPI website (asyncapi.com and asyncapi.org), along with their description, goals, members, and anything the Working Group wants to include. +Working Groups should be listed on the [AsyncAPI website](https://www.asyncapi.com), along with their description, goals, members, and anything the Working Group wants to include. From 3f0863cbfdb93d8c0bba42fd72c9ea2d6237d657 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Tue, 27 Feb 2024 14:28:42 +0200 Subject: [PATCH 8/8] Update WORKING_GROUPS.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fran Méndez --- WORKING_GROUPS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WORKING_GROUPS.md b/WORKING_GROUPS.md index 3ae469ed3..09dcf853c 100644 --- a/WORKING_GROUPS.md +++ b/WORKING_GROUPS.md @@ -8,7 +8,7 @@ Anyone can create a Working Group. The only prerequisites are to have at least 3 A Working Group should have clearly defined goals that are easily accessible to everyone on the internet, as this helps maintain alignment within the group. -The Working Group should have an associated project management tool like [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project) (or any other project management tool) to outline their roadmap. It's up to the Working Group to decide the structure of the project. E.g., Kanban, Shape Up, TO-DO list, etc. +It is recommended that the Working Group has an associated project management tool like [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project) (or any other project management tool) to outline their roadmap. It's up to the Working Group to decide the structure of the project. E.g., Kanban, Shape Up, TO-DO list, etc. The group's name, members, goals, and other relevant information must be added to the `WORKING_GROUPS.yaml` file in the `community` repository.