1build icon indicating copy to clipboard operation
1build copied to clipboard

Improve code standard - fix markdown linters from codacy

Open gopinath-langote opened this issue 5 years ago • 5 comments

Description

1build cares a lot about code standards and readability. When we run the simple code standard checks - we found that some things are missing from the language standards, like markdown, golang, etc.

Issues can be found here: https://app.codacy.com/app/gopinath-langote/1build/issues/index?bid=13534878

From All Patterns section -section below mentioned issue patterns.

This issue will focus on - solving markdown file related topics listed below

  1. Warn when the spacing between a list item’s bullet and its content
  2. Warn for too many consecutive blank lines. Knows about the extra line
  3. Warn when list looseness is incorrect, such as being tight
  4. Warn when duplicate headings are found.

Remove the blank titles from Changelog.md file, ex, #security section without content

  1. Warn when a heading ends with a a group of characters.
  2. Warn when file names contain irregular characters: characters other than
  3. Warn when the content of a list item has mixed indentation.
  4. Warn when the list-item marker style of unordered lists violate a given
  5. Warn when multiple top-level headings are used.

Acceptance Criteria

  1. Lint messages with above type should not exist after this PR

Tech note:

  1. You can use automatic tools suggested by codacy to fix this.

gopinath-langote avatar Aug 30 '19 07:08 gopinath-langote

@gopinath-langote can you assign this to me. I have started working on issue #133 Thanks.

themayurkumbhar avatar Sep 27 '19 07:09 themayurkumbhar

@themayurkumbhar Sure. go for it.

gopinath-langote avatar Sep 27 '19 07:09 gopinath-langote

feel free ask for help in case you are not able find details in codacy.

gopinath-langote avatar Sep 27 '19 08:09 gopinath-langote

Hello @themayurkumbhar - any progress on the ticket - let me know if you need any help on the issue.

gopinath-langote avatar Oct 08 '19 13:10 gopinath-langote

Hi @gopinath-langote , Updated the code with resolving .md lint issues. also added the configuration file for .md files lint. let me know for any issues.

themayurkumbhar avatar Oct 08 '19 18:10 themayurkumbhar