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

Markdownlint: Add blacklisted exact matches to TOP001 #28557

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

MaoShizhong
Copy link
Contributor

Because

While flagging "this" and "here" in link text labels has been working well, it's still common that "fixed" or even new links come with labels like "video" or "article", which are insufficiently descriptive.

While we can't catch everything (context-dependent), we can blacklist some of the most common phrases which can aid maintainers as well as potentially educate more contributors if they flag that error. These must only flag for exact matches, not just if the link text includes it somewhere ("video" should flag but not "video about binary search trees").

This PR

  • Adds array of blacklisted link text labels to TOP001 custom rule, and flags on a blacklist error (with blacklist-specific error message).
  • Adds examples of blacklisted text labels to TOP001 test file.
    • Amended placeholder link hrefs as duplicates are fine (and no need to adjust numbers)
  • Updates TOP001 doc file with new flag criteria and examples.

Issue

N/A

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

@MaoShizhong MaoShizhong added the Content: Markdownlint Involves anything related to the curriculum repo linter label Aug 2, 2024
More enforcing language
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: Markdownlint Involves anything related to the curriculum repo linter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants