Skip to content

Commit

Permalink
add more to community section
Browse files Browse the repository at this point in the history
  • Loading branch information
flybayer committed Sep 24, 2020
1 parent 674fd9a commit a250f72
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 8 deletions.
24 changes: 19 additions & 5 deletions docs/contributing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ If you want, [watch this video](https://www.youtube.com/watch?v=RBAkhDrVRiA&feat

## What to Work On?

Issues with the label [`status/ready-to-work-on`](https://github.com/blitz-js/blitz/labels/status%2Fready-to-work-on) are the best place to start. If you find one that looks interesting and no one else is already working on it, comment in the issue that you are going to work on it. Please ask as many questions as you need, either directly in the issue or in Slack. We're happy to help!
Issues with the label [`status/ready-to-work-on`](https://github.com/blitz-js/blitz/labels/status%2Fready-to-work-on) are the best place to start.

If you find one that looks interesting and no one else is already working on it, comment in the issue that you are going to work on it. But only claim an issue if you can start work on it within a couple days.

Please ask as many questions as you need, either directly in the issue or in Slack. We're happy to help!

The Blitzjs.com website and documentation repo also has issues with [`ready to work on | help wanted`](https://github.com/blitz-js/blitzjs.com/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22ready+to+work+on+%7C+help+wanted%22).

Expand All @@ -38,10 +42,6 @@ After you contribute in any way, please add yourself as a contributor via the [@

The Blitz codebase is like a community garden. There's a lot of beautiful plants and vegetables, but it won't take long until you find some weeds! When you find weeds, please remove them :) Minor refactoring is always encouraged. If you'd like to do some major refactoring, it's best to first either open an issue or check with us in Slack. Most likely we'll agree with you.

## Project Management

We use a [Github Project Board](https://github.com/blitz-js/blitz/projects/2) to track all issues and PRs.

## What to Expect After Submitting a PR

A Blitz maintainer will review your PR, usually within a couple days.
Expand All @@ -54,6 +54,20 @@ Once all the requirements are met and the maintainer is happy with your code, th

Lastly, you will be added the all-contributors list as an official Blitz contributor. **Congratulations!!**

## Project Management

We use a [Github Project Board](https://github.com/blitz-js/blitz/projects/2) to track all issues and PRs.

## Commit Access

We give liberal commit access to the Blitz repo to anyone who is a half-way regular contributor. This allows you to push branches directly to the Blitz repo without using a fork.

We'll often give someone access if we notice they are regularly contributing. But you're also welcome to ask for access if you are regularly helping but haven't been given access yet.

In the main Blitz repo, code reviews by code owners are required to merge PRs.

But in the docs repo, anyone can merge PRs once someone else has approved the PR.

## Development Setup

**1.** Fork [the blitz repo](https://github.com/blitz-js/blitz)
Expand Down
6 changes: 4 additions & 2 deletions docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ sidebar_label: Getting Started
Before getting started, you should know **this is alpha software**. Blitz is incomplete. There are rough spots and bugs. APIs may change. But you can build an app and deploy it to production. We're excited to see what you build!
:::

If you have any issues at all, please [open an issue](https://github.com/blitz-js/blitz/issues/new/choose) or join the [Blitz slack](https://slack.blitzjs.com) and talk to us in the **#help** channel. If you get stuck and frustrated, please don't blame yourself. Our docs are not yet fine-tuned for those with less experience. But eventually, it will be because this is very important to us!

## Quick Start

#### Set Up Your Computer
Expand Down Expand Up @@ -49,6 +47,10 @@ The Blitz community is warm, safe, diverse, inclusive, and fun! LGBTQ+, women, a

For questions and longer form discussions, [post in our forum.](https://github.com/blitz-js/blitz/discussions)

:::info
**For a full introduction, read [How the Community Operates](./how-the-community-operates)**. This details everything, including how to get help, how to report bugs, how to suggest new features, etc.
:::

#### You are invited to help — let’s build the future of web dev together! 🤝

We have an awesome community that's working together to make Blitz the best framework the world has ever seen.
Expand Down
7 changes: 6 additions & 1 deletion docs/maintainers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ The primary responsibilities of level 1 maintainers are:
- Issue triage
- Pull request triage
- Monitor and answer the `#-help` slack channel
- Following up on assigned issues to make sure they are being worked on
- Following up on in-progress PRs to make sure they don't get stuck
- Community encouragement
- Community moderation
- Tracking and ensuring progress of key issues

## Level 2 Maintainers

Expand All @@ -39,6 +40,10 @@ The primary responsibilities of level 2 maintainers are:
- Merging pull requests
- Tracking and ensuring progress of open pull requests

## Retiring

Maintainers may retire from their role at any time without any shame or guilt. Simply let a core team member know!

## ⚠️ Fundamentals

Maintainers are the face of the project and the front-line touch point for the community. Therefore maintainers have the very important responsibility of making people feel welcome, valued, understood, and appreciated.
Expand Down

0 comments on commit a250f72

Please sign in to comment.