About module scoring

Modules on the Puppet Forge have two scores to help you evaluate their quality. The module quality score tells you whether a module passes Puppet's code standards, and the community rating tells you whether other Puppet users have found the module useful. You can find these scores on every module page on the Forge.

Quality score

The module quality score is based on code style checks, compatibility tests, and metadata validation. This score gives you an idea of the module's overall adherence to Puppet code standards.

To see details about a specific module's quality score, click details under the quality score or select the Scores tab below the module details box. This tab displays information about the module's code quality, Puppet compatibility, and metadata quality.

Quality score details

For details about which checks the module passed or failed, click View full results... This expands information about the checks run, with quality flags indicating errors, warnings, notices, and successes.

Quality flags as detailed in text below

Quality flags

Error

An error flag indicates a severe problem with the module. The flag is appended to the line causing the issue, which could be anything from a critical bug to a serious code style issue. If you are the module's author, an error flag negatively impacts your score most heavily.

Warning

A warning flag indicates a general problem with the module. The flag is appended to the line causing the issue, which could be minor nonconformance with the style guide or another minor issue in the module's structure or code. If you are the module's author, a warning flag negatively impacts your score, but it is weighted less heavily than an error.

Notice

A notice flag indicates something in the module that warrants attention, either positive or negative. Notices do not impact the module's score.

Success

A success flag indicates that the module completely conforms to Puppet compatibility or metadata requirements. This flag tells you whether the module meets standards such as listing operating system compatibility and including a verified source url. If you are the module's author, a success flag positively impacts your score.

Updates

When a new version of the module is released, the quality scoring tests are rerun and an updated score is displayed. The quality score box also shows how much the score has changed since the last release.

Evaluating your module's quality

To determine whether your module passes or fails the quality score standards, be sure to validate and run unit tests on your module using Puppet Development Kit. PDK can run the same kinds of validations that the Forge runs to determine your score.

Community rating

The module community rating is based on user responses to the questions found on every module page on the Forge:

  • How helpful are the docs?
  • How easy to use?
  • Does what it promises?
  • Works without changes?
  • Used in production?

The community rating shows how many users have answered the questions and a score based on the average of all user responses.

To see details about a specific module's community rating, click details under the community rating or select the Scores tab on the module page. The Scores tab appears below the module details box and displays information about how many users have responded and the average of their answers to each of the questions.

Scale showing average community ratings for each question