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

change: Link two VSCode extensions mentioned in our Coding Standards docs #10643

Conversation

mjac0bs
Copy link
Contributor

@mjac0bs mjac0bs commented Jul 3, 2024

Description 📝

A tiny PR to update the Coding Standard sections of our Cloud Manager Docs to include links to two of our most important VSCode extensions. I found myself linking the extension, rather than our docs, in a PR review comment where linting needed to happen. We might as well include these links in our docs.

Changes 🔄

  • Adds links to the listed VS Code extensions
  • Adds emphasis

Preview 📷

Before After
Screenshot 2024-07-03 at 12 14 58 PM Screenshot 2024-07-03 at 12 05 46 PM

How to test 🧪

Verification steps

(How to verify changes)

  • Check out this PR, run yarn docs locally, go to the Coding Standards page, and confirm the above changes.
  • Or just look at the diff.

As an Author I have considered 🤔

Check all that apply

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset (I don't think this is significant enough to need a changeset)
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

@mjac0bs mjac0bs added the Documentation Improving / adding to our documentation label Jul 3, 2024
@mjac0bs mjac0bs self-assigned this Jul 3, 2024
@mjac0bs mjac0bs requested a review from a team as a code owner July 3, 2024 19:19
@mjac0bs mjac0bs requested review from bnussman-akamai and abailly-akamai and removed request for a team July 3, 2024 19:19
Copy link

github-actions bot commented Jul 3, 2024

Coverage Report:
Base Coverage: 82.19%
Current Coverage: 82.19%

@@ -11,7 +11,7 @@ We use [ESLint](https://eslint.org/) to enforce coding and formatting standards.
- **prettier** (code formatting)
- **scanjs** (security)

If you are using VSCode it is highly recommended to use the ESlint extension. The Prettier extension is also recommended, as it can be configured to format your code on save.
If you are using VSCode it is **highly** recommended to use the [ESlint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint). The [Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) is also recommended, as it can be configured to format your code on save.
Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you!

@mjac0bs mjac0bs merged commit 0e6227b into linode:develop Jul 3, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improving / adding to our documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants