Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • C create-react-app
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 1,547
    • Issues 1,547
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 417
    • Merge requests 417
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Meta
  • create-react-app
  • Merge requests
  • !9241

Updated README.md Templates to Follow ESLint Markdown Rules

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/wrenchingdev/Update-README-to-follow-eslint-rules into master Jul 01, 2020
  • Overview 5
  • Commits 1
  • Pipelines 0
  • Changes 2

Created by: wrenchingdev

Updated README.md in both templates (JS/TS) to adhere to the following Markdown ESLint rules. This isn't a big change to how create-react-app works, but I'm submitting this as my eslint plugin in VS Code complains about these rules every time I open the README.md file locally.

  • MD041 - First line in file should be a top level heading
  • MD033 - Inline HTML
  • MD034 - Bare URL used

Screenshots below show the markdown changes applied (Left) and original version (right). Note that the only visible change is the top level heading Getting Started with Create React App is now present. All other changes will display as they did before while adhering to the ESLint rules.

Side Notes:

  1. No test plan has been added as this is only for the README.md file.
  2. Only showing screenshot for regular JS template, as the links at the bottom are the only difference with the TS template.

README.md - side by side view

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/wrenchingdev/Update-README-to-follow-eslint-rules