1build
1build copied to clipboard
Improve code standard - fix markdown linters from codacy
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
- Warn when the spacing between a list item’s bullet and its content
- Warn for too many consecutive blank lines. Knows about the extra line
- Warn when list looseness is incorrect, such as being tight
- Warn when duplicate headings are found.
Remove the blank titles from Changelog.md file, ex,
#security
section without content
- Warn when a heading ends with a a group of characters.
- Warn when file names contain irregular characters: characters other than
- Warn when the content of a list item has mixed indentation.
- Warn when the list-item marker style of unordered lists violate a given
- Warn when multiple top-level headings are used.
Acceptance Criteria
- Lint messages with above type should not exist after this PR
Tech note:
- You can use automatic tools suggested by codacy to fix this.
@gopinath-langote can you assign this to me. I have started working on issue #133 Thanks.
@themayurkumbhar Sure. go for it.
feel free ask for help in case you are not able find details in codacy.
Hello @themayurkumbhar - any progress on the ticket - let me know if you need any help on the issue.
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.