StackStorm/st2contrib — pull request #87 by Kami (2014-12-31 15:50:38+00:00)
Title: [WIP] Add script which verifies pack contains a README which satisfies a particular criteria

This pull request adds a "lint" script which checks that pack contains a "README.md" file which satisfies the following criteria:

* README.md file exists
* Readme contains configuration section if config.yaml file exists
* Readme contains a section for each sensor available in the pack
* Readme contains a section for each action available in the pack

Note 1: Yes, the script is a bit hacky, but automated checks are better and less error-prone than no or manual checks.

Note 2: Yes, the script enforces a particular README structure, but that's not bad, in fact, quite the contrary. Structure and consistency is good. Eventually, we should also create a "pack bootstrap tool" which creates a README.md template which files this particular structure.