Similar to scorecard and similar efforts, this will be a simple cli tool that looks at a handful of metrics and attempts to produce a health score and/or risk rating for a given Wikimedia code repository. This is part of a WMF effort to better measure and understand potentially problematic, production-deployed code. Some initial design details:
- The cli tool will support MediaWiki extensions and skins as initial use-cases.
- The cli tool will be able to analyze either a local git repo (.git present) or remote hosted under gerrit.wikimedia.org, gitlab.wikimedia.org or github.com/wikimedia.
- The cli tool will support as much automation as possible from the discussed methodology/metrics section within the working doc.
- The cli tool will be designed with the idea of being able to be run within CI.
- The cli tool will be used to generate some initial reports (as test cases) for the Graph, StructuredDiscussions and Kartographer extensions.