21 Template

koalaman edited this page 2018-01-19 18:54:43 -08:00

Table of Contents

• (Message goes here, use code and foo wisely)
• Problematic code:
• Correct code:
• Rationale:
• Exceptions:
• Related resources:

(Message goes here, use code and foo wisely)

Problematic code:

# Simple example of problematic code

Correct code:

# Simple example of above code, only fixed

Rationale:

(An explanation of why the code is problematic and how the correct code is an improvement)

Exceptions:

(Cases where the user may choose to ignore this warning, if any.)

Related resources:

• Help by adding links to BashFAQ, StackOverflow, man pages, POSIX, etc!

ShellCheck

• Installation

  • CentOS6
  • More Installation Guides

• Usage

  • Directive
  • Ignore

• Integrating and extending

  • Misc. contributions
  • Azure Pipelines
  • Buildkite
  • CircleCI
  • DevGuide
  • Integration
  • JUnit
  • Phabricator
  • TravisCI
  • GitLab CI
  • Drone
  • GitHub Actions

• Severity

• Template

Each individual ShellCheck warning has its own wiki page like SC1000. Use GitHub Wiki's "Pages" feature above to find a specific one, or see Checks.