Creating a scorecard config skeleton file to assist with scorecard setup #59
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR: Add Skeleton Scorecard Manifest File
What is the Scorecard
The Scorecard is a brand new curated framework for assessing the operational maturity of an individual service against Deliveroo's engineering standards, providing a structured pathway from minimum compliance to industry excellence.
Deliveroo's manual service readiness process has been essential in ensuring our services are production-ready. However, it has been challenging to track the readiness of all services across the organisation and can often become stale as services evolve over time. The new Scorecard revamps the existing service readiness process into a largely automated and near-real-time tracker of your service's readiness and quality metrics. We will be launching the Scorecard over the next few weeks, so keep an eye out for more information!
Summary
Most metrics in the Scorecard are automatically evaluated, however some metrics require manual input from the owning team. This PR introduces a skeleton scorecard manifest file to the repository, allowing us to cover all aspects of the existing service readiness process and more - over time, we plan to shrink this file as we automate the evaluation of more and more Scorecard metrics.
Action Required
Please can you review and merge the skeleton manifest file into your repo. You are not required to fill in any information yet, further announcements about this will occur in the coming weeks. However, if you wish to see an example of a populated scorecard manifest file, you can do so in this example. Check out the config file documentation for more information too.
.scorecard/config.yml
file in your repo and will automatically evaluate the information supplied in the file.🙏 Although we've added a
to-stage
label for repos that are using Marvin, not all repos are using Marvin or have a unique staging process, if the latter applies to you, please stage these changes yourself✅ If you're happy with the changes, please can you go ahead and merge after you're reviewed to help us track progress - thank you!
Questions
If you have any questions, please reach out to us on Slack in the Scorecards Support channel.