docs: Audit and streamline CONTRIBUTING.md #5595
Conversation
|
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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
Hi Team, do we have any discord server? FYI: the doc changes are inspired by https://github.com/ngrx/platform/blob/master/CONTRIBUTING.md |
5c58a02 to
dce56b4
Compare
There was a problem hiding this comment.
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...
| return { | ||
| collapsed, | ||
| collapsible: collapsed, |
There was a problem hiding this comment.
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.
CONTRIBUTING.md
Outdated
|
|
||
| ## 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> |
There was a problem hiding this comment.
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.
| ## 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> |
CONTRIBUTING.md
Outdated
|
|
||
| Please provide **_as much information as possible_**. This project is maintained by volunteers, so the more information you provide, the less likely we will have to waste everyone's time in asking you for more information. | ||
|
|
||
| If you have a particularly complex issue - consider creating a small, self-contained reproduction repo. 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 - 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. |
There was a problem hiding this comment.
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?
| 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. |
CONTRIBUTING.md
Outdated
| Questions and requests for support should not be opened as issues and should be handled in the following ways: | ||
|
|
||
| - Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/typescript-eslint) using the `typescript-eslint` tag. | ||
| - Join our [Discord server](https://discord.com/invite/??). |
There was a problem hiding this comment.
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.
| - Join our [Discord server](https://discord.com/invite/??). | |
| - Publicly tweet [@tseslint on Twitter](https://twitter.com/tseslint). |
CONTRIBUTING.md
Outdated
| @@ -70,20 +77,40 @@ We have a sophisticated CI process setup which gets run on every PR. You must pa | |||
| Once your changes are ready, you can raise a PR. The title of your PR should match the following format: | |||
|
|
|||
| ```text | |||
| <tag>(<package>): <short description> | |||
| <type>(<package>): <Subject> (#Issue Number) | |||
There was a problem hiding this comment.
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?
CONTRIBUTING.md
Outdated
| <type>(<package>): <Subject> (#Issue Number) | ||
| ``` | ||
|
|
||
| Samples: (even more [samples](https://github.com/typescript-eslint/typescript-eslint/commits/main)) |
There was a problem hiding this comment.
Linking to the latest commits is a good idea. But this sentence is a little oddly worded. Maybe...
| 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.
f5092a8 to
11e3fef
Compare
|
Thanks for reviewing @JoshuaKGoldberg please check now. |
11e3fef to
d39b0af
Compare
|
🙌 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. 🙂 |
|
Ahh sorry for that 😅 will keep this in mind. |
There was a problem hiding this comment.
Sorry for the delay here, lost track from just having the one note. Thanks for sending this in @santoshyadavdev! Looks great! ❤️
PR Checklist
Overview