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: update pull requests docs to include a how to ask section #6872

Merged
merged 3 commits into from
Apr 8, 2023

Conversation

sfavello
Copy link
Contributor

@sfavello sfavello commented Apr 8, 2023

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. 😅

added a how to ask section in pull request docs
@typescript-eslint
Copy link
Contributor

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.

@netlify
Copy link

netlify bot commented Apr 8, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 3befe6e
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6431e3ce3141440008c97d95
😎 Deploy Preview https://deploy-preview-6872--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.

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a 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.

docs/contributing/Pull_Requests.mdx Outdated Show resolved Hide resolved
docs/contributing/Pull_Requests.mdx Outdated Show resolved Hide resolved
@JoshuaKGoldberg
Copy link
Member

Btw @sfavello we normally put the PR description in the body text after Overview, where it's commented <!-- Description of what is changed and how the code change does that. -->. I went ahead and edited this PR. Very small thing 😄

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Apr 8, 2023
sfavello and others added 2 commits April 8, 2023 14:56
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.
Copy link
Member

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)

Suggested change
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.

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a 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!

@JoshuaKGoldberg JoshuaKGoldberg merged commit f0f83ce into typescript-eslint:main Apr 8, 2023
38 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
awaiting response Issues waiting for a reply from the OP or another party
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Mention how to ask for help with PRs
2 participants