aws-doc-sdk-examples icon indicating copy to clipboard operation
aws-doc-sdk-examples copied to clipboard

[EPIC]: Language Level Linting READMEs

Open beqqrry-aws opened this issue 2 years ago • 1 comments

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.

  • [x] #6425
  • [ ] Bash / CLI Level Linting README
  • [ ] C++ Language Level Linting README
  • [ ] Go Language Level Linting README
  • [x] #6366
  • [x] #6565
  • [x] #6433
  • [x] #6426
  • [x] #6439
  • [x] #5997
  • [ ] Swift Language Level Linting README

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

beqqrry-aws avatar Sep 08 '22 14:09 beqqrry-aws

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>

ford-at-aws avatar Sep 08 '22 18:09 ford-at-aws