Skip to content

Commit

Permalink
Update readme standards declaration (willthames#42)
Browse files Browse the repository at this point in the history
README update, specify how to declare standards
  • Loading branch information
vmindru authored and willthames committed Jan 23, 2018
1 parent 9850c4d commit ea5c1f9
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,12 @@ standards = [

When you add new standards, you should increment the version of your standards.
Your playbooks and roles should declare what version of standards you are
using, otherwise ansible-review assumes you're using the latest.
using, otherwise ansible-review assumes you're using the latest. The declaration
is done by adding standards version as first line in the file. e.g.

```
# Standards: 1.2
```

To add standards that are advisory, don't set the version. These will cause
a message to be displayed but won't constitute a failure.
Expand Down

0 comments on commit ea5c1f9

Please sign in to comment.