Skip to content

[EPIC]: Language Level Linting READMEs #3583

Open
@beqqrry-aws

Description

@beqqrry-aws

Each language needs a section in its README file giving instructions for how to run the linter. These instructions should let the user run the linter with the same specifications as used by the SuperLinter so users can properly lint local files before uploading them.

Requirements:

  • Describe the setup and what command to run our linting config on their local machine (using terminal) (optional depending on language)
    Describe how to run from fork/branch on GitHub

Activity

ford-at-aws

ford-at-aws commented on Sep 8, 2022

@ford-at-aws
Contributor

Possible language:

To view the results of our linting configurations 
on your own fork, click the Actions tab and 
<insert instructions to find linting results in GH>

Alternatively, you can install the <insert language linter> 
package locally and execute the following command 
in a Terminal session (Mac or Windows) from
 <insert language directory>:

< insert single-line command for 
executing linting for your language>
changed the title [-]EPIC: Language Level Linting READMEs[/-] [+][EPIC]: Language Level Linting READMEs[/+] on Oct 23, 2023
removed their assignment
on Jan 24, 2024

4 remaining items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

InternalTo help track internal tickets in a single location.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    [EPIC]: Language Level Linting READMEs · Issue #3583 · awsdocs/aws-doc-sdk-examples