From 29c78559528071550c4fba71233802fcba541c61 Mon Sep 17 00:00:00 2001 From: Supriya M Date: Fri, 8 Sep 2023 12:49:52 +0530 Subject: [PATCH 1/3] doc: how to become a maintainer --- .../how-to-become-a-maintainer.md | 36 +++++++++++++++++++ docs/How-To-Guides/how-to-style-play.md | 6 +++- 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 docs/How-To-Guides/how-to-become-a-maintainer.md diff --git a/docs/How-To-Guides/how-to-become-a-maintainer.md b/docs/How-To-Guides/how-to-become-a-maintainer.md new file mode 100644 index 0000000..4a2248d --- /dev/null +++ b/docs/How-To-Guides/how-to-become-a-maintainer.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# How to become a Maintainer of ReactPlay + +ReactPlay is an open-source community that welcomes volunteers to become maintainers. If you are interested in becoming a maintainer, here are the criteria and requirements you need to meet. + +## About the Role + +- It is a volunteer effort. 🙋‍♂️ +- You must have a love for open source and people. 💛 +- You may have to give 4-5 hours a week. ⏳ + +## Criteria + +- Be a Contributor first. Make sure you have contributed to at least 2 issues to understand the ReactPlay ecosystem, processes, and accepting criteria for any contributions. +- Make a short write-up explaining why do you want to take up this role? This write-up should be no more than 150 words. +- Schedule a meeting with [tapas.adhikary@gmail.com](mailto:tapas.adhikary@gmail.com) for 15 mins to discuss your points. + +Don't forget to read out everything that is listed here: https://opensource.guide/best-practices/ + +## Please Note + +1. You do not need prior experience in maintaining an Open Source project to be a maintainer of ReactPlay. +1. We welcome everyone who is interested in becoming a maintainer, and if we are not able to get you started immediately, it doesn't mean we are rejecting you. +1. If there is a gap that you need to bridge and come back, we will communicate that to you. +1. We are looking for maintainers who are committed to the project for the long term. + +## Existing roles + +- Community Manager +- Social & Events +- Maintainers +- Content +- Dev Enablement diff --git a/docs/How-To-Guides/how-to-style-play.md b/docs/How-To-Guides/how-to-style-play.md index 99b0641..e1f0326 100644 --- a/docs/How-To-Guides/how-to-style-play.md +++ b/docs/How-To-Guides/how-to-style-play.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 2 +--- + # How to add styling to your Play Styling is an essential part of any play, and it's crucial to follow best practices to ensure that your code is maintainable and scalable. Here are some **Dos and Don'ts** to keep in mind when adding styling to your play: @@ -35,7 +39,7 @@ function MyComponent() { ## Don'ts - Do not use inline styles unless necessary. Inline styles can make your code harder to read and maintain, and they can also negatively impact performance. Instead, use CSS classes to style your components. This approach helps to keep your code organized and makes it easier to maintain. -For example, instead of using inline styles like this: + For example, instead of using inline styles like this: ```jsx function MyComponent() { From df7dac91d4375065e71baf327a45c9a8cd53775a Mon Sep 17 00:00:00 2001 From: Supriya M Date: Fri, 8 Sep 2023 13:17:47 +0530 Subject: [PATCH 2/3] refactor: review comment changes --- docs/How-To-Guides/how-to-become-a-maintainer.md | 6 +++--- docs/How-To-Guides/how-to-style-play.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/How-To-Guides/how-to-become-a-maintainer.md b/docs/How-To-Guides/how-to-become-a-maintainer.md index 4a2248d..72260fd 100644 --- a/docs/How-To-Guides/how-to-become-a-maintainer.md +++ b/docs/How-To-Guides/how-to-become-a-maintainer.md @@ -2,9 +2,9 @@ sidebar_position: 3 --- -# How to become a Maintainer of ReactPlay +# How to Become a ReactPlay Open Source Project Maintainer -ReactPlay is an open-source community that welcomes volunteers to become maintainers. If you are interested in becoming a maintainer, here are the criteria and requirements you need to meet. +[ReactPlay](https://reactplay.io/) is an open-source community that welcomes volunteers to become maintainers. If you are interested in becoming a maintainer, here are the criteria and requirements you need to meet. ## About the Role @@ -16,7 +16,7 @@ ReactPlay is an open-source community that welcomes volunteers to become maintai - Be a Contributor first. Make sure you have contributed to at least 2 issues to understand the ReactPlay ecosystem, processes, and accepting criteria for any contributions. - Make a short write-up explaining why do you want to take up this role? This write-up should be no more than 150 words. -- Schedule a meeting with [tapas.adhikary@gmail.com](mailto:tapas.adhikary@gmail.com) for 15 mins to discuss your points. +- Schedule a meeting with [https://zcal.co/tapasadhikary/15min](https://zcal.co/tapasadhikary/15min) for 15 mins to discuss your points. Don't forget to read out everything that is listed here: https://opensource.guide/best-practices/ diff --git a/docs/How-To-Guides/how-to-style-play.md b/docs/How-To-Guides/how-to-style-play.md index e1f0326..3b3fb64 100644 --- a/docs/How-To-Guides/how-to-style-play.md +++ b/docs/How-To-Guides/how-to-style-play.md @@ -2,7 +2,7 @@ sidebar_position: 2 --- -# How to add styling to your Play +# How to Add Styling to Your Play Styling is an essential part of any play, and it's crucial to follow best practices to ensure that your code is maintainable and scalable. Here are some **Dos and Don'ts** to keep in mind when adding styling to your play: From 411a75671a293d53709bfb50c894c4576aecd5ee Mon Sep 17 00:00:00 2001 From: Supriya M Date: Fri, 8 Sep 2023 13:27:40 +0530 Subject: [PATCH 3/3] chore: embed meeting link --- docs/How-To-Guides/how-to-become-a-maintainer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/How-To-Guides/how-to-become-a-maintainer.md b/docs/How-To-Guides/how-to-become-a-maintainer.md index 72260fd..af48f41 100644 --- a/docs/How-To-Guides/how-to-become-a-maintainer.md +++ b/docs/How-To-Guides/how-to-become-a-maintainer.md @@ -16,7 +16,7 @@ sidebar_position: 3 - Be a Contributor first. Make sure you have contributed to at least 2 issues to understand the ReactPlay ecosystem, processes, and accepting criteria for any contributions. - Make a short write-up explaining why do you want to take up this role? This write-up should be no more than 150 words. -- Schedule a meeting with [https://zcal.co/tapasadhikary/15min](https://zcal.co/tapasadhikary/15min) for 15 mins to discuss your points. +- [Schedule a meeting](https://zcal.co/tapasadhikary/15min) with our existing project maintainer for 15 mins to discuss your points. Don't forget to read out everything that is listed here: https://opensource.guide/best-practices/