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

Improve code standard - fix markdown linters from codacy #133

Open
gopinath-langote opened this issue Aug 30, 2019 · 5 comments
Open

Improve code standard - fix markdown linters from codacy #133

gopinath-langote opened this issue Aug 30, 2019 · 5 comments
Assignees
Labels
documentation Create/Update documents enhancement New feature or request good first issue Good for first time contributors Hacktoberfest Support to https://hacktoberfest.digitalocean.com/ In Progress Someone working on the issue
Milestone

Comments

@gopinath-langote
Copy link
Owner

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 gopinath-langote added documentation Create/Update documents enhancement New feature or request good first issue Good for first time contributors help wanted Extra attention is needed labels Aug 30, 2019
@gopinath-langote gopinath-langote added this to To do in Feature Ideas / Bug tracker via automation Aug 30, 2019
@gopinath-langote gopinath-langote added this to the v2.0.0 milestone Aug 30, 2019
@gopinath-langote gopinath-langote changed the title Improve code standard - fix linters from codacy Improve code standard - fix markdown linters from codacy Aug 30, 2019
@gopinath-langote gopinath-langote pinned this issue Aug 30, 2019
@gopinath-langote gopinath-langote added the Hacktoberfest Support to https://hacktoberfest.digitalocean.com/ label Sep 12, 2019
@gopinath-langote gopinath-langote unpinned this issue Sep 12, 2019
@gopinath-langote gopinath-langote modified the milestones: v1.3.0, v2.0.0 Sep 24, 2019
@themayurkumbhar
Copy link
Contributor

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

@gopinath-langote
Copy link
Owner Author

@themayurkumbhar Sure. go for it.

@gopinath-langote
Copy link
Owner Author

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

@gopinath-langote gopinath-langote added In Progress Someone working on the issue and removed help wanted Extra attention is needed labels Sep 27, 2019
@gopinath-langote gopinath-langote moved this from To do to In progress in Feature Ideas / Bug tracker Sep 27, 2019
themayurkumbhar added a commit to themayurkumbhar/1build that referenced this issue Sep 27, 2019
themayurkumbhar added a commit to themayurkumbhar/1build that referenced this issue Sep 27, 2019
themayurkumbhar added a commit to themayurkumbhar/1build that referenced this issue Sep 27, 2019
themayurkumbhar added a commit to themayurkumbhar/1build that referenced this issue Sep 27, 2019
themayurkumbhar added a commit to themayurkumbhar/1build that referenced this issue Sep 27, 2019
themayurkumbhar added a commit to themayurkumbhar/1build that referenced this issue Sep 27, 2019
@gopinath-langote
Copy link
Owner Author

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

themayurkumbhar added a commit to themayurkumbhar/1build that referenced this issue Oct 8, 2019
themayurkumbhar added a commit to themayurkumbhar/1build that referenced this issue Oct 8, 2019
@themayurkumbhar
Copy link
Contributor

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.

@gopinath-langote gopinath-langote modified the milestones: v1.4.0, v1.5.0 Oct 9, 2019
@gopinath-langote gopinath-langote modified the milestones: v1.5.0, v1.6.0 Apr 1, 2020
@gopinath-langote gopinath-langote modified the milestones: v1.6.0, v1.7.0 Aug 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Create/Update documents enhancement New feature or request good first issue Good for first time contributors Hacktoberfest Support to https://hacktoberfest.digitalocean.com/ In Progress Someone working on the issue
Projects
Development

No branches or pull requests

2 participants