docs: remove incorrect configs from vscode readme#11043
docs: remove incorrect configs from vscode readme#11043eng-abdelrahman-sharaf wants to merge 1 commit intostdlib-js:developfrom
Conversation
this misleading instructions caused the problem discussed in https://stdlib.zulipchat.com/#narrow/channel/546735-dev-questions/topic/.E2.9C.94.20eslint.20errors.20in.20test.2Ejs.20files/with/580387664 --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
|
👋 Hi there! 👋 And thank you for opening your first pull request! We will review it shortly. 🏃 💨 Getting Started
Next Steps
Running Tests LocallyYou can use # Run tests for all packages in the math namespace:
make test TESTS_FILTER=".*/@stdlib/math/.*"
# Run benchmarks for a specific package:
make benchmark BENCHMARKS_FILTER=".*/@stdlib/math/base/special/sin/.*"If you haven't heard back from us within two weeks, please ping us by tagging the "reviewers" team in a comment on this PR. If you have any further questions while waiting for a response, please join our Zulip community to chat with project maintainers and other community members. We appreciate your contribution! Documentation Links |
There was a problem hiding this comment.
Pull request overview
Removes misleading VS Code workspace configuration guidance (notably around ESLint) from the VS Code editor documentation to prevent users from triggering erroneous lint errors.
Changes:
- Removed README instructions recommending an
eslint.options.configFileworkspace override. - Added a markdown-lint disable comment for document structure rules.
- Fixed a couple of formatting/whitespace issues in the README.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Remove these misleading instructions, which caused the eslint errors problem discussed in Zulip
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes. report:
Resolves None
Description
This pull request:
Related Issues
This pull request has the following related issues:
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
@stdlib-js/reviewers