-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: update pull requests docs to include a how to ask section #6872
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
Conversation
added a how to ask section in pull request docs
Thanks for the PR, @sfavello! 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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM in general! A couple of suggestions for touching up the wording, would love your thoughts.
Btw @sfavello we normally put the PR description in the body text after Overview, where it's commented |
change title Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
Add proofreading change to add more clarity. Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
|
||
### Asking Questions | ||
|
||
If you need help and/or have a question, posting a comment in the PR is a great way to do so. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(lil grammar nit since the heading is updated)
If you need help and/or have a question, posting a comment in the PR is a great way to do so. | |
If you need help and/or have a question, posting a comment in the PR is a great way to ask. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔥 great! Thanks for iterating on this @sfavello!
PR Checklist
Overview
Added a how to ask section in pull request docs. I wasn't sure what the title section should be. I might be overthinking it, but labeling it ask "How to ask for help" felt too specific. People might not be just asking for help but wanting to ask questions (to gain insight, clarification, etc). Again I might be overthinking it. 😅