search

h1alexbel / fakehub

GitHub API Server Stub. Fully functional fake version of a GitHub API that supports all the features and works locally, with no connection to GitHub at all.
MIT License
5 stars 0 forks source link

Add markdown lint #48

Closed h1alexbel closed 3 months ago

h1alexbel commented 3 months ago

Let's add a linter for markdown, especially for README.md. In order to control its quality

h1alexbel commented 3 months ago

I'm in

github-actions[bot] commented 3 months ago

@h1alexbel thanks for the report, here is a feedback:

Problems

  1. Clear problem statement is missing: The bug report does not indicate the precise issue or bug with the existing markdown lint, if any, or what functionality is expected from the new markdown lint.
  2. Description of the current situation is lacking: The report does not offer any information about the current state of markdown linting in the project, making it difficult to evaluate the need for change or enhancements.

I would recommend clearly defining the issue or bug related to the current markdown lint, such as "The current markdown lint does not properly handle underscores in headings, leading to formatting issues in README.md."

Please fix the bug report in order it to get resolved faster. Analyzed with Phind/Phind-CodeLlama-34B-v2