Skip to content

docs: mention VS Code debugging tasks in CONTRIBUTING.md #4374

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

Merged
merged 1 commit into from
Dec 31, 2021

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Mentions the very nice .vscode/launch.json tasks already checked in.

@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 Dec 30, 2021

☁️ Nx Cloud Report

CI ran the following commands for commit 00b9500. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 48 targets

Sent with 💌 from NxCloud.

@netlify
Copy link

netlify bot commented Dec 30, 2021

✔️ Deploy Preview for typescript-eslint ready!

🔨 Explore the source changes: 00b9500

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/61ce2c4059b8ce0007d94bdb

😎 Browse the preview: https://deploy-preview-4374--typescript-eslint.netlify.app

@@ -53,6 +53,7 @@ We have a sophisticated CI process setup which gets run on every PR. You must pa
- You can run `yarn typecheck` in any package or in the root.
- Ensure your changes are adequately tested.
- You can run `yarn test` in any package.
- [VS Code launch tasks](https://code.visualstudio.com/docs/editor/tasks) tasks are provided that allow [visual debugging](https://code.visualstudio.com/docs/editor/debugging) tests
Copy link
Member Author

Choose a reason for hiding this comment

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

@tapanprakasht is this the info you were hoping to see added?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, this should be sufficient to debug the code.

@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Dec 31, 2021
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.

@bradzacher bradzacher merged commit 6acb4d6 into typescript-eslint:main Dec 31, 2021
@JoshuaKGoldberg JoshuaKGoldberg deleted the docs-debugging branch January 1, 2022 03:47
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 1, 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: Development environment setup guide
3 participants