Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EPIC]: Language Level Linting READMEs #3583

Open
7 of 13 tasks
beqqrry-aws opened this issue Sep 8, 2022 · 1 comment
Open
7 of 13 tasks

[EPIC]: Language Level Linting READMEs #3583

beqqrry-aws opened this issue Sep 8, 2022 · 1 comment
Assignees

Comments

@beqqrry-aws
Copy link
Contributor

beqqrry-aws commented Sep 8, 2022

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
@ford-at-aws
Copy link
Contributor

ford-at-aws commented Sep 8, 2022

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>

@github-actions github-actions bot removed the Epic label Jul 20, 2023
@cpyle0819 cpyle0819 changed the title EPIC: Language Level Linting READMEs [EPIC]: Language Level Linting READMEs Oct 23, 2023
@DavidSouther DavidSouther removed their assignment Jan 24, 2024
@rlhagerm rlhagerm removed their assignment May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

8 participants