Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: how to become a maintainer #74

Merged
merged 3 commits into from
Sep 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/How-To-Guides/how-to-become-a-maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
sidebar_position: 3
---

# How to Become a ReactPlay Open Source Project Maintainer

[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

- 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](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/

## 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
8 changes: 6 additions & 2 deletions docs/How-To-Guides/how-to-style-play.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# How to add styling to your Play
---
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:

Expand Down Expand Up @@ -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() {
Expand Down