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

Layout Style Guide: Add new rules #27720

Conversation

MaoShizhong
Copy link
Contributor

Because

With the addition of the TOP005 rule in #27674, the layout style guide needs to be updated to include that rule.

Two other rules were missing from the style guide:

  1. Use markdown links instead of HTML anchor tags
  2. Use the long name for codeblock languages, for any languages that have a long and short form (e.g. javascript and js)

This PR

  • Adds the rule covered by TOP005 to the layout style guide
  • Also adds a clarification to use markdown links instead of HTML anchor tags
  • Adds clarification for using the long language name for codeblocks if a short option is also acceptable
  • Fixed TOP005_test.md to abide by the long language name rule

Issue

N/A

Additional Information

The only linting errors that should be present are the expected TOP005 errors from TOP005_test.md.

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project 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

Copy link
Contributor

@thatblindgeye thatblindgeye left a comment

Choose a reason for hiding this comment

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

Just one quick change below. Rather than " you should do this..." we should (ha) probably say "You must do this". Make it clear that we will only accept long form names, especially with a rule being made for it/a possible fixer being done.

LAYOUT_STYLE_GUIDE.md Outdated Show resolved Hide resolved
Co-authored-by: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com>
@MaoShizhong MaoShizhong merged commit 7664915 into TheOdinProject:main Mar 31, 2024
2 of 3 checks passed
@MaoShizhong MaoShizhong deleted the chore/add-new-rules-to-layout-style-guide branch March 31, 2024 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants