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

docs: add maintainer guide (take two) #5874

Merged

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Builds off of #5263, including a couple main changes:

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@nx-cloud
Copy link

nx-cloud bot commented Oct 24, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit eea220c. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 46 targets

Sent with 💌 from NxCloud.

@netlify
Copy link

netlify bot commented Oct 24, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit eea220c
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6363c413fa77db0008b0069b
😎 Deploy Preview https://deploy-preview-5874--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@@ -17,6 +17,25 @@ replies:
\
If you need it sooner, please try the `canary` tag on NPM.
name: Fix Has Been Merged
- body: |
Thanks for the report @<reporter>!\
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm really getting into this extension heh. JoshuaKGoldberg/refined-saved-replies#45

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review October 24, 2022 21:46
JamesHenry
JamesHenry previously approved these changes Oct 25, 2022
Copy link
Member

@JamesHenry JamesHenry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Me gusta mucho!

Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pardon my wall of comments—I love making random editorial suggestions as I read.

docs/maintenance/ISSUES.md Outdated Show resolved Hide resolved
docs/maintenance/ISSUES.md Outdated Show resolved Hide resolved
docs/maintenance/ISSUES.md Show resolved Hide resolved
docs/maintenance/ISSUES.md Show resolved Hide resolved
docs/maintenance/ISSUES.md Outdated Show resolved Hide resolved
docs/maintenance/ISSUES.md Outdated Show resolved Hide resolved
docs/maintenance/ISSUES.md Outdated Show resolved Hide resolved
docs/maintenance/ISSUES.md Outdated Show resolved Hide resolved
docs/maintenance/ISSUES.md Outdated Show resolved Hide resolved
docs/maintenance/ISSUES.md Outdated Show resolved Hide resolved
@bradzacher
Copy link
Member

bradzacher commented Oct 30, 2022

Also, this seems to be focused on bug reports. Do feature requests have different accepting prs procedure?

Yeah this is based off of my docs and so far I had only covered bug report issues.

Feature requests are something along the lines of:

  1. The request must be related to TS syntax, or propose a check that requires type information to be accurate.
    • This is for cases where people propose something like "I want to prevent people using arrow functions". Not TS-specific, nor does it need type-info -> doesn't belong in this project.
  2. The request must be useful to the broader TS community (put another way - we as maintainers have to assess it as something a large portion of users might want to use [based on our experience]).
    • This is hard as it's kind-of subjective. Most of the time this exists to give us an out for when people request something like "my project uses this very specific style, can you make a rule to enforce it?"
    • I am generally really strict on this check when it comes to rule options. Rule options are very expensive to maintain (forks in code = double testing), so I always want a really solid and broadly usable proposal for an option.
  3. The request should not fit into the purview of another popular plugin (eg eslint-plugin-import, eslint-plugin-jest, eslint-plugin-promises, ...)
    • We want to avoid stepping on other plugin's toes!
  4. The request should be framework agnostic. We don't accept rules for react-specific features, or angular, jest, mocha, etc. There's plugins/projects for each of those specific things, and we are framework agnostic on purpose.
    • One caveat here is that we support what TS supports out of the box. I.e. TS supports JSX syntax, so we do to - but we don't support react semantics / types.

A lot of the checks here exist to ensure we're not just adding rules or options willy-nilly so that we can keep a lid on the maintenance burden of the project.

The TL;DR for the above constraints is just "there has to be a really good and broadly applicable TS-specific usecase for us to add an option or new rule".

bradzacher
bradzacher previously approved these changes Oct 31, 2022
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few comments but otherwise looking great - thanks for taking this the whole way!

docs/maintenance/VERSIONING.md Outdated Show resolved Hide resolved
docs/maintenance/VERSIONING.md Outdated Show resolved Hide resolved
docs/maintenance/RELEASES.md Outdated Show resolved Hide resolved
docs/maintenance/RELEASES.md Outdated Show resolved Hide resolved
docs/maintenance/RELEASES.md Outdated Show resolved Hide resolved
docs/maintenance/RELEASES.md Show resolved Hide resolved
Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
@JoshuaKGoldberg JoshuaKGoldberg merged commit 9c130cc into typescript-eslint:main Nov 3, 2022
@JoshuaKGoldberg JoshuaKGoldberg deleted the maintainer-docs-take-2 branch November 3, 2022 13:43
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Add a Maintainer Guide / Maintenance section to the website
4 participants