etopeter/kubectl-view-utilization

View on GitHub
.github/ISSUE_TEMPLATE/bug_report.md

Summary

Maintainability
Test Coverage

First line in file should be a top level header
Open

---

MD041 - First line in file should be a top level header

Tags: headers

Aliases: first-line-h1

Parameters: level (number; default 1)

This rule is triggered when the first line in the file isn't a top level (h1) header:

```
This is a file without a header
```

To fix this, add a header to the top of your file:

```
# File with header

This is a file with a top level header
```

Note: The level parameter can be used to change the top level (ex: to h2) in cases where an h1 is added externally.

Lists should be surrounded by blank lines
Open

- Operating system that client is running

MD032 - Lists should be surrounded by blank lines

Tags: bullet, ul, ol, blank_lines

Aliases: blanks-around-lists

This rule is triggered when lists (of any kind) are either not preceded or not followed by a blank line:

Some text
* Some
* List

1. Some
2. List
Some text

To fix this, ensure that all lists have a blank line both before and after (except where the block is at the beginning or end of the document):

Some text

* Some
* List

1. Some
2. List

Some text

Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse lists that don't have blank lines before and after them.

Note: List items without hanging indents are a violation of this rule; list items with hanging indents are okay:

* This is
not okay

* This is
  okay

There are no issues that match your filters.

Category
Status