Skip to main content

This site requires you to update your browser. Your browsing experience maybe affected by not having the most up to date version.

 

Robots and humans unite: Module scores available now

We now have a simple way to check module rating against the module standard. See how a module is doing at a glance.

Read post

We had an interesting encounter earlier this year. Our automaton friend, Helpful Robot, extended the olive branch mentioning that it had been busy inspecting our community modules and looking for ways to be, well... helpful.

To help us make sense of Helpful Robot's interesting statistics about our modules, we ran a survey, in which many of you took part.

Here's what you told us about the importance of quality modules in the SilverStripe ecosystem:

Based on these three key pieces of data, we are delighted to say we've integrated with Helpful Robot's module scoring API and can now provide a simple way to check modules rating against the more objective aspects of the module standard. While we are providing a simple visual indicator (the new "dot" next to all the modules). We've gone for shape and contrast colours so you can, at a glance, see how a module is doing.

 module score

The dot indicator can be read as such:

 ModuleRatingSystem 70+

Green is meeting 70+% of the standard as measured by the API.

 ModuleRatingSystem AboveAvg

Half green represents the module scores above the overall community average score and less than 70%.

ModuleRatingSystem BelowAvg

Grey indicates the module scores below community average score. 

You can also find out in which areas the module could be improved in a more detailed UI for each module.

module score details

If you are a module maintainer (65% of you that took the survey were!), this will help you know where to put your efforts to gain some additional module standard points. If you are looking to select a module for a project, it should also help make an informed decision when selecting modules for use. For this first roll-out, we've kept things simple and will be later adapting the indicator and scoring based on further feedback and practical usage. We figure “best to get something released, test it and fine tune”.

The reason we've gone in this direction (apart from an overwhelming number of you asking for this score to be published) was that one of the top ways developers indicated in the survey as to how they currently select modules was looking at simple indicators of module quality. This included the presence of documentation, tests, good module structure and other aspects like a module being correctly licensed under a free (as in freedom) & open source (FOSS) license. It is some of these key areas that the score is calculated on, so it will save you some time not having to peek at the module source when making that initial short list of modules for a project.  

Just note, at this point, Helpful Robot is sticking to those things that can understandably be objectively assessed in respect to the standard. The score is also weighed on aspects of complexity and effort that maintainers put into setting up those things being measured. For example, you get a higher portion of the overall score from having things like docs and tests (because we know how you love to write these things and the effort required to do them well). We may revise these scores once we've had time to determine their usefulness.

So check out the new module scores on addons, and let us know below in the comments if you find them useful.

For maintainers, Helpful Robot is working to raise some handy pull requests against many modules. If they make sense, gaining a better score may be as simple as merging a pull request or two.

For users of modules, we're hoping this helps raise module quality and selection process when making use of the many community modules in projects.

Thanks Helpful Robot, you sure live up to your name! Go check out the update to the Addons website now.

About the author
Cam Findlay

Cam is our Developer Advocate, joining the team after impressing them with his insightful keynotes about community development at the SilverStripe meetups.

Post your comment

Comments

  • Thanks for the feedback Kevin. It's a good idea would you be able to either... raise this as an issue over at https://github.com/silverstripe/addons.silverstripe.org/ OR if you like, you could raise a Pull Request with an improvement. I'm happy to peer review and manage the rolling releases of the site.

    Posted by Cam Findlay, 08/04/2016 3:35pm (3 years ago)

  • This is a really useful addition and I hate to be a party pooper! For devs who use assistive tech, the implementation of the dot and tick indicators won't provide them with any info.

    Any chance to include some content in the indicator. For example, use;

    <div class="circle circle-sml green">Good</div>

    or

    <div class="circle circle-sml green">
    <div class="circle-half">Average</div>
    </div>

    The text content can be neatly moved off screen, just gives something useful for those who might not be able to perceive the awesomely helpful dots.

    Posted by Kevin, 07/04/2016 8:36pm (3 years ago)

  • This looks like a great addition and provides an incentive to adhere to the new module guidelines. Looks like moving documentation out of ReadMe.md will provide good bang for buck with the current weightings. BRB, got to fix some grey dots.

    Posted by Jono, 05/04/2016 6:05am (3 years ago)

RSS feed for comments on this page | RSS feed for all comments

Like what you have read?

Sign up for our weekly blog digest sent to your inbox.

Subscribe