-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: formalized v1 maintenance docs
- Loading branch information
1 parent
b872154
commit 1aabf91
Showing
13 changed files
with
370 additions
and
22 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
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,177 @@ | ||
| --- | ||
| id: contributor-tiers | ||
| title: Contributor Tiers | ||
| --- | ||
|
|
||
| These tiers of contributors, committers, and maintainers roughly reflect how we've worked the past several years. | ||
|
|
||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Tier</th> | ||
| <th>Entry Requirements</th> | ||
| <th>Monthly Expectations</th> | ||
| <th>Monthly Reimbursement</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <th>Contributor</th> | ||
| <td>1 point</td> | ||
| <td> | ||
| <em>(none)</em> | ||
| </td> | ||
| <td> | ||
| <em>(none)</em> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <th>Code Contributor</th> | ||
| <td>1 point in pull requests</td> | ||
| <td> | ||
| <em>(none)</em> | ||
| </td> | ||
| <td> | ||
| <em>(none)</em> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <th>Committer</th> | ||
| <td> | ||
| ~5 points in issues | ||
| <br /> | ||
| ~5 points in pull requests | ||
| <br /> | ||
| ~15 points total | ||
| <br />2 of 4 consecutive active months | ||
| </td> | ||
| <td>~10 points</td> | ||
| <td>~1 share / active month</td> | ||
| </tr> | ||
| <tr> | ||
| <th>Maintainer</th> | ||
| <td> | ||
| ~10 points in issues | ||
| <br /> | ||
| ~10 points in pull requests | ||
| <br /> | ||
| ~30 points total | ||
| <br />3 of 6 active months | ||
| </td> | ||
| <td>~20 points</td> | ||
| <td>~2 shares / active month</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| :::note | ||
| We treat everything here as approximate numbers. | ||
| We're a small enough team to informally discuss changes ad hoc and allow off-by-one-or-two months. | ||
| ::: | ||
|
|
||
| ## Pointing | ||
|
|
||
| Although it's impossible to accurately estimate software projects, we want to roughly establish expectations of effort+time spent on the tiers. | ||
| These are all rough estimations and should be taken as approximate starting guides to consider. | ||
|
|
||
| We treat both the creation and review of issues and PRs along the rough scale of: | ||
|
|
||
| <table> | ||
| <thead> | ||
| <tr> | ||
| <th>Size</th> | ||
| <th>Description</th> | ||
| <th>Points</th> | ||
| <th>Examples</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <th>Trivial</th> | ||
| <td>Small typos or single-file bugfixes</td> | ||
| <td>1</td> | ||
| <td> | ||
| <a href="https://github.com/typescript-eslint/typescript-eslint/issues/6976"> | ||
| #6976 | ||
| </a> | ||
| , <a href="https://github.com/typescript-eslint/typescript-eslint/issues/6992">#6992</a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <th>Straightforward</th> | ||
| <td>2-3 files at most, with minimal logical changes</td> | ||
| <td>2</td> | ||
| <td> | ||
| <a href="https://github.com/typescript-eslint/typescript-eslint/issues/6780"> | ||
| #6780 | ||
| </a> | ||
| , <a href="https://github.com/typescript-eslint/typescript-eslint/issues/6910">#6910</a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <th>Large</th> | ||
| <td>Multi-file logical changes that require real review+thought</td> | ||
| <td>3</td> | ||
| <td> | ||
| <a href="https://github.com/typescript-eslint/typescript-eslint/issues/6107"> | ||
| #6107 | ||
| </a> | ||
| , <a href="https://github.com/typescript-eslint/typescript-eslint/issues/6907">#6907</a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <th>Unusual</th> | ||
| <td>Dozen+ file logical changes that require deep investigation</td> | ||
| <td>≥5*</td> | ||
| <td> | ||
| <a href="https://github.com/typescript-eslint/typescript-eslint/issues/6084"> | ||
| #6084 | ||
| </a> | ||
| , <a href="https://github.com/typescript-eslint/typescript-eslint/issues/6777">#6777</a> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| > \*Unusually large efforts may be >5 points at maintainer discretion depending on time spent. | ||
| Any other activities (e.g. responding to Discord threads, working on upstream dependencies, …) should be treated as gaining points equal to their nearest equivalent point task in terms of complexity and effort. | ||
|
|
||
| ## Advancement | ||
|
|
||
| Each tier corresponds to a role on Discord. | ||
| When you first hit a tier, you can post in the [`#contributing` channel on Discord](https://discord.gg/TODO). | ||
|
|
||
| We will confirm privately that you've hit the intent of the contribution tiers. | ||
| We'll then grant you the role on Discord and profusely thank you for everything you've done. ❤️ | ||
|
|
||
| ### Recognition | ||
|
|
||
| Depending on the tier you reach, you can also provide information for the [Team page](./Team.mdx): | ||
|
|
||
| - Contributor and Code Contributor: Preferred photo, name, social media handles | ||
| - Committer and Maintainer: ~2 paragraph bio of yourself | ||
|
|
||
| See existing bios for examples of what to put. | ||
|
|
||
| :::note | ||
| You can decline to opt into the Discord role or site recognition, and you can always opt out after the fact. | ||
| Nothing is mandatory. | ||
| We just like including recognition as thanks to the community for working with us. 💕 | ||
| ::: | ||
|
|
||
| ## Reimbursement | ||
|
|
||
| Team members will be reimbursed the minimum of their activity level and their tier. | ||
| Each month: | ||
|
|
||
| - Committers and maintainers who hit their expectation receive their full shares | ||
| - Committers and maintainers who hit roughly half their expectation receive half shares | ||
|
|
||
| Reimbursements are generally handled through [our Open Collective page](https://opencollective.com/typescript-eslint). | ||
|
|
||
| ### Community Reimbursements | ||
|
|
||
| Contributors who contribute nontrivial changes in a month (roughly ≥5 points and at least one _Large_ item) may be privately nominated at any time by a committer or maintainer to be reimbursed at the equivalent shares. | ||
|
|
||
| Our intention is to always do this for contributors who submit _Large_ or greater contributions and don't need significant assistance in getting them merged. |
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,4 @@ | ||
| --- | ||
| id: governance | ||
| title: Governance | ||
| --- |
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
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
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
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,45 @@ | ||
| --- | ||
| id: team | ||
| title: Team | ||
| --- | ||
|
|
||
| import { TeamBioList } from '@site/src/components/team/TeamBioList'; | ||
|
|
||
| ## Maintainers | ||
|
|
||
| <TeamBioList | ||
| bios={[ | ||
| { | ||
| description: 'Lorem ipsum.', | ||
| photo: '', | ||
| name: 'Brad Zacher', | ||
| }, | ||
| { | ||
| description: 'Lorem ipsum.', | ||
| photo: '', | ||
| name: 'James Henry', | ||
| }, | ||
| { | ||
| description: 'Lorem ipsum.', | ||
| photo: '', | ||
| name: 'Josh Goldberg', | ||
| }, | ||
| ]} | ||
| /> | ||
|
|
||
| ## Committers | ||
|
|
||
| <TeamBioList | ||
| bios={[ | ||
| { | ||
| description: 'Lorem ipsum.', | ||
| photo: '', | ||
| name: 'Armano2', | ||
| }, | ||
| { | ||
| description: 'Lorem ipsum.', | ||
| photo: '', | ||
| name: 'Joshua Chen', | ||
| }, | ||
| ]} | ||
| /> |
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
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
Oops, something went wrong.