-
-
Notifications
You must be signed in to change notification settings - Fork 110
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add info about working groups (#1075)
Co-authored-by: V Thulisile Sibanda <[email protected]>
- Loading branch information
1 parent
95d898e
commit 0361b9e
Showing
2 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 clearly defined goals that are easily accessible to everyone on the internet, as this helps maintain alignment within the group. | ||
|
||
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. | ||
|
||
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](https://www.asyncapi.com), along with their description, goals, members, and anything the Working Group wants to include. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# 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: 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. | ||
# 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. |