mysql / mysql/mysql-shell-plugins

Broken link in root README

Open Beginner friendly
#21 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
96
Forks
22
PR merge metrics
No merged PRs in 30d

Description

The link to MySQL Shell for VS Code is broken in the main readme, because it links to gui/extension/readme.md but the filename is uppercased (README.md).

In my (humble) opinion, the file should be renamed to lowercase, simply because it seems to be the most common across readme's in this project, but the link could also be changed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the root README and inspect the MySQL Shell for VS Code link, then compare its target with gui/extension/README.md in the repository. Choose the link or filename correction consistent with the project’s README naming, and verify that the root README link resolves to the intended file.

Written by the indexing model from the issue text.

Assessment

Tech stack
mysql, vscode
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.