GoogleCloudPlatform / GoogleCloudPlatform/pubsec-declarative-toolkit

Code Linting Discussion

Open
#274 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
36
Forks
26
PR merge metrics
No merged PRs in 30d

Description

I've een working on some of the code in my own repo, getting some of the CICD pipelines configured.

In that fork, when I enabled Yaml linting via Super-Linter I noticed that a lot of linting warnings were returning.

Manually going through the code, most of the linting issues are issues with code blocks that have been copy/pasted and also I think one of the contributors is/was running Prettier code auto formatter.

So I was wondering if we could have a deeper discussion about a yaml format for this code base.

Something like

```
rules:
comments:
require-starting-space: true
ignore-shebangs: true
min-spaces-from-content: 2
document-end:
present: true
document-start:
present: true
line-length:
max: 80
allow-non-breakable-words: true
allow-non-breakable-inline-mappings: false
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.