docs: Audit and streamline CONTRIBUTING.md

[santoshyadavdev]

PR Checklist

• Addresses an existing open issue: fixes Docs: Audit and streamline CONTRIBUTING.md #5120
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit fdbffd3. 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 47 targets

• nx run-many --target=build --all --parallel --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/visitor-keys
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/type-utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/typescript-estree
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/visitor-keys --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=typecheck --all --parallel
• Node 14 - nx test @typescript-eslint/scope-manager --coverage=false
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-internal
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/parser
• Node 14 - nx test @typescript-eslint/eslint-plugin --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/ast-spec
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/type-utils --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/utils --coverage=false
• Node 18 - nx test @typescript-eslint/scope-manager
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/parser --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 14 - nx test @typescript-eslint/eslint-plugin-tslint --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/typescript-estree --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website

---

Sent with 💌 from NxCloud.

[typescript-eslint]

Thanks for the PR, @santoshyadavdev!

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.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	fdbffd3
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/63392e64137f95000951f8bc
😎 Deploy Preview	https://deploy-preview-5595--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[santoshyadavdev]

Hi Team, do we have any discord server?

FYI: the doc changes are inspired by https://github.com/ngrx/platform/blob/master/CONTRIBUTING.md

[JoshuaKGoldberg]

Hey thanks for sending this in @santoshyadavdev!

You make some good suggestions. I'll go through and do another pass after this PR too - been thinking about it off-and-on...

[JoshuaKGoldberg]

Would you mind moving the sidebar changes for #5554 to another PR? That way we can get them in sooner - and it's easier to keep track when it's one-issue-per-PR.

[JoshuaKGoldberg]

I don't think contributors & sponsors information belongs in our CONTRIBUTING.md. We already showcase contributors on the root README.md and sponsors on the website. Let's keep each page as small as possible.

Suggested change

	## Financial contributions
	We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/typescript-eslint).
	Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
	### Contributors
	Thank you to all the people who have already contributed to typescript-eslint!
	<a href="https://github.com/typescript-eslint/typescript-eslint/graphs/contributors"><img src="https://opencollective.com/typescript-eslint/contributors.svg?width=890" /></a>
	### Backers
	Thank you to all our backers! [[Become a backer](https://opencollective.com/typescript-eslint#backer)]
	<a href="https://opencollective.com/typescript-eslint#backers" target="_blank"><img src="https://opencollective.com/typescript-eslint/backers.svg?width=890"></a>
	### Sponsors
	Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/typescript-eslint#sponsor))
	<a href="https://opencollective.com/typescript-eslint/sponsor/0/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/0/avatar.svg"></a>
	<a href="https://opencollective.com/typescript-eslint/sponsor/1/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/1/avatar.svg"></a>
	<a href="https://opencollective.com/typescript-eslint/sponsor/2/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/2/avatar.svg"></a>
	<a href="https://opencollective.com/typescript-eslint/sponsor/3/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/3/avatar.svg"></a>
	<a href="https://opencollective.com/typescript-eslint/sponsor/4/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/4/avatar.svg"></a>
	<a href="https://opencollective.com/typescript-eslint/sponsor/5/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/5/avatar.svg"></a>
	<a href="https://opencollective.com/typescript-eslint/sponsor/6/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/6/avatar.svg"></a>
	<a href="https://opencollective.com/typescript-eslint/sponsor/7/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/7/avatar.svg"></a>
	<a href="https://opencollective.com/typescript-eslint/sponsor/8/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/8/avatar.svg"></a>
	<a href="https://opencollective.com/typescript-eslint/sponsor/9/website" target="_blank"><img src="https://opencollective.com/typescript-eslint/sponsor/9/avatar.svg"></a>

[santoshyadavdev]

cool

[JoshuaKGoldberg]

The complex issue template is meant for things that can't be demonstrated on the playground. +1 to mentioning it though. How does this strike you?

Suggested change

	If you have a particularly complex issue - consider creating a small, self-contained reproduction repo or use our [playground](https://typescript-eslint.io/play). This will help you in figuring out the exact problem, and will help us in reproducing and diagnosing the bug.
	If you have a particularly complex issue that can't be reproduced on [our playground](https://typescript-eslint.io/play) - consider creating a small, self-contained reproduction repo or use. This will help you in figuring out the exact problem, and will help us in reproducing and diagnosing the bug.

[JoshuaKGoldberg]

Indeed, we don't have one. We're not paid enough to deal with a flood of realtime questions from the public. 😄

Pending what the other maintainers think, I'm up for directing people to ask on Twitter instead. I'm pretty active there.

Suggested change

	- Join our [Discord server](https://discord.com/invite/??).
	- Publicly tweet [@tseslint on Twitter](https://twitter.com/tseslint).

[JoshuaKGoldberg]

The (#Issue Number) gets added by GitHub. We don't need it.

Also, I kind of like short description more than Subject TBH. It's more clear what it's supposed to be: short, not a whole long ordeal. Thoughts?

[JoshuaKGoldberg]

Linking to the latest commits is a good idea. But this sentence is a little oddly worded. Maybe...

Suggested change

	Samples: (even more [samples](https://github.com/typescript-eslint/typescript-eslint/commits/main))
	You can find more samples of good past PR titles in [recent commits to `main`](https://github.com/typescript-eslint/typescript-eslint/commits/main))

Related: it's an accessibility necessity to have informative link titles. When screenreader folks navigate through the page by skipping through links, they don't receive context around the links. Titles like "samples" don't make much sense out of context.

[santoshyadavdev]

Thanks for reviewing @JoshuaKGoldberg please check now.

[JoshuaKGoldberg]

🙌 will do!

Btw, you don't need to force push (#5170) or tag me, we have a queue that I go through whenever I can. 🙂

[santoshyadavdev]

Ahh sorry for that 😅 will keep this in mind.

[JoshuaKGoldberg]

Sorry for the delay here, lost track from just having the one note. Thanks for sending this in @santoshyadavdev! Looks great! ❤️