awsdocs / aws-doc-sdk-examples

Welcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.
Apache License 2.0
9.19k stars 5.54k forks source link

[EPIC]: Language Level Linting READMEs #3583

Open beqqrry-aws opened 1 year ago

beqqrry-aws commented 1 year ago

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:

ford-at-aws commented 1 year ago

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>