From 7e1565fd2a4e4b90140a3f9726cbed58be0b9761 Mon Sep 17 00:00:00 2001 From: BekahHW Date: Fri, 22 Sep 2023 15:19:05 -0400 Subject: [PATCH 1/8] Add maintainers-guide --- docs/maintainers/maintainers-guide.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/maintainers/maintainers-guide.md diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md new file mode 100644 index 00000000..e69de29b From 4ff49dc502c94d406d7090deb943dc40b57229a7 Mon Sep 17 00:00:00 2001 From: BekahHW Date: Fri, 22 Sep 2023 16:39:20 -0400 Subject: [PATCH 2/8] Add maintainers guide file --- docs/maintainers/maintainers-guide.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md index e69de29b..c6e0da53 100644 --- a/docs/maintainers/maintainers-guide.md +++ b/docs/maintainers/maintainers-guide.md @@ -0,0 +1,7 @@ +--- +id: maintainers-guide +title: "@open-sauced/maintainers-guide" +sidebar_label: "@open-sauced/maintainers-guide" +keywords: + - "@open-sauced/maintainers-guide" +--- From 27b38012731a660c60949075f546032768692483 Mon Sep 17 00:00:00 2001 From: BekahHW Date: Mon, 25 Sep 2023 20:39:12 -0400 Subject: [PATCH 3/8] Rearrange --- docs/maintainers/maintainers-guide.md | 4 ++++ docs/maintainers/setting-up-a-new-repository.md | 5 ----- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md index c6e0da53..2a638743 100644 --- a/docs/maintainers/maintainers-guide.md +++ b/docs/maintainers/maintainers-guide.md @@ -5,3 +5,7 @@ sidebar_label: "@open-sauced/maintainers-guide" keywords: - "@open-sauced/maintainers-guide" --- +## How do I Join the Maintainers Team? +- Sign up for [opensauced.pizza](https://opensauced.pizza/) +- Join discord. +Prove your pizza worth! diff --git a/docs/maintainers/setting-up-a-new-repository.md b/docs/maintainers/setting-up-a-new-repository.md index 86c3f0e7..2ac82569 100644 --- a/docs/maintainers/setting-up-a-new-repository.md +++ b/docs/maintainers/setting-up-a-new-repository.md @@ -6,11 +6,6 @@ keywords: - setting up a new repository --- -## How do I Join the Maintainers Team? - -1. Sign up for [opensauced.pizza](https://opensauced.pizza) -1. Join [discord](https://discord.gg/gZMKK5q). -1. Prove your pizza worth! ## Requirements From a76181bbb49e6d836fcbe50d388f30871ff1aa54 Mon Sep 17 00:00:00 2001 From: BekahHW Date: Wed, 27 Sep 2023 07:57:08 -0700 Subject: [PATCH 4/8] Add draft of content --- docs/maintainers/maintainers-guide.md | 32 ++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md index 2a638743..ddb2d0e2 100644 --- a/docs/maintainers/maintainers-guide.md +++ b/docs/maintainers/maintainers-guide.md @@ -5,7 +5,37 @@ sidebar_label: "@open-sauced/maintainers-guide" keywords: - "@open-sauced/maintainers-guide" --- + +Welcome to OpenSauced, Maintainers Guide for contributors who are interested in being part of the maintainer team for OpenSauced repositories. + +At OpenSauced, we're empowering contributors to work in the open and supporting maintainers to make data-driven decisions for their projects. + +It's important to us that we maintain a healthy environment for contributors and maintainers of our projects. + ## How do I Join the Maintainers Team? - Sign up for [opensauced.pizza](https://opensauced.pizza/) - Join discord. -Prove your pizza worth! +- Prove your pizza worth! + +## What does the Maintainers Team do? +Well, like all things in tech, it depends. We have different maintainer teams for each of the repositories, so it's important that you communicate with the admin maintainer if you have any questions. + +### Core Responsibilities +Your responsibilities may include: +- Reviewing and merging pull requests. +- Addressing issues and bug reports. +- Maintaining project documentation. +- Collaborating with the community. + +As a maintainer, you must: +- Adhere to our [Code of Conduct](../contributing/code-of-conduct.md) and be an example for treating contributors with respect. +- Communicate with the other maintainers in a timely and reasonable manner. +- Understand and adhere to project standards. + +## Committing and Merging Changes +1. For commit and pull request standards, please refer to [introduction to contributing](../contributing/introduction-to-contributing.md). +2. Before merging in changes, be sure to run the project locally if UI changes were made. +3. Squash and merge commits when you merge in a PR. + +Thank you for your interest in becoming a maintainer! Please reach out if you need help, guidance, or clarification at any time. + From ca5dcbc40f619742d0fb4e8afac61eec006f66de Mon Sep 17 00:00:00 2001 From: BekahHW Date: Wed, 27 Sep 2023 11:13:46 -0700 Subject: [PATCH 5/8] Remove empty file and add styling --- docs/maintainers/maintainers-guide.md | 7 +++++-- introduction.md | 0 2 files changed, 5 insertions(+), 2 deletions(-) delete mode 100644 introduction.md diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md index ddb2d0e2..b14979b5 100644 --- a/docs/maintainers/maintainers-guide.md +++ b/docs/maintainers/maintainers-guide.md @@ -23,10 +23,13 @@ Well, like all things in tech, it depends. We have different maintainer teams fo ### Core Responsibilities Your responsibilities may include: - Reviewing and merging pull requests. -- Addressing issues and bug reports. +- Providing comments and responses on PRs, issues, discussions, and Discord messages. +- [Triage issues](../contributing/triage-guide.md) and bug reports. - Maintaining project documentation. - Collaborating with the community. +**Think of creating a positive space for contributors at all stages as one of your most important responsibilities.** + As a maintainer, you must: - Adhere to our [Code of Conduct](../contributing/code-of-conduct.md) and be an example for treating contributors with respect. - Communicate with the other maintainers in a timely and reasonable manner. @@ -35,7 +38,7 @@ As a maintainer, you must: ## Committing and Merging Changes 1. For commit and pull request standards, please refer to [introduction to contributing](../contributing/introduction-to-contributing.md). 2. Before merging in changes, be sure to run the project locally if UI changes were made. -3. Squash and merge commits when you merge in a PR. +3. **Squash and merge commits** when you merge in a PR. Thank you for your interest in becoming a maintainer! Please reach out if you need help, guidance, or clarification at any time. diff --git a/introduction.md b/introduction.md deleted file mode 100644 index e69de29b..00000000 From 5047d150dff6daa11f4413064ec8be3ea4210615 Mon Sep 17 00:00:00 2001 From: BekahHW Date: Wed, 27 Sep 2023 13:46:38 -0700 Subject: [PATCH 6/8] Add abbreviation for pull request --- docs/maintainers/maintainers-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md index b14979b5..87502942 100644 --- a/docs/maintainers/maintainers-guide.md +++ b/docs/maintainers/maintainers-guide.md @@ -22,7 +22,7 @@ Well, like all things in tech, it depends. We have different maintainer teams fo ### Core Responsibilities Your responsibilities may include: -- Reviewing and merging pull requests. +- Reviewing and merging pull requests (PRs). - Providing comments and responses on PRs, issues, discussions, and Discord messages. - [Triage issues](../contributing/triage-guide.md) and bug reports. - Maintaining project documentation. From 99f95055279cd52af32d0a045460989360da8865 Mon Sep 17 00:00:00 2001 From: BekahHW Date: Wed, 27 Sep 2023 21:12:51 -0700 Subject: [PATCH 7/8] Add link to team discussions --- docs/maintainers/maintainers-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md index 87502942..28cb9dfa 100644 --- a/docs/maintainers/maintainers-guide.md +++ b/docs/maintainers/maintainers-guide.md @@ -6,7 +6,7 @@ keywords: - "@open-sauced/maintainers-guide" --- -Welcome to OpenSauced, Maintainers Guide for contributors who are interested in being part of the maintainer team for OpenSauced repositories. +Welcome to OpenSauced Maintainers Guide for contributors who are interested in being part of the maintainer team for OpenSauced repositories. At OpenSauced, we're empowering contributors to work in the open and supporting maintainers to make data-driven decisions for their projects. @@ -40,5 +40,5 @@ As a maintainer, you must: 2. Before merging in changes, be sure to run the project locally if UI changes were made. 3. **Squash and merge commits** when you merge in a PR. -Thank you for your interest in becoming a maintainer! Please reach out if you need help, guidance, or clarification at any time. +Thank you for your interest in becoming a maintainer! Please reach out in our [team discussions](https://github.com/open-sauced/docs/discussions/categories/team-discussions) if you need help, guidance, or clarification at any time. From 070fe0c15ffc2c0eec11bdc743164ad0cd0dc177 Mon Sep 17 00:00:00 2001 From: BekahHW Date: Wed, 27 Sep 2023 21:14:52 -0700 Subject: [PATCH 8/8] Add link to discord that doesn't expire --- docs/maintainers/maintainers-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md index 28cb9dfa..37ce8096 100644 --- a/docs/maintainers/maintainers-guide.md +++ b/docs/maintainers/maintainers-guide.md @@ -14,7 +14,7 @@ It's important to us that we maintain a healthy environment for contributors and ## How do I Join the Maintainers Team? - Sign up for [opensauced.pizza](https://opensauced.pizza/) -- Join discord. +- Join our [Discord community](https://discord.gg/opensauced). - Prove your pizza worth! ## What does the Maintainers Team do?