Code Coverage Where It Matters Most: CodeScene Rollout Steps that Work
A Strategic 5-Week Onboarding Framework for Engineering Teams seeking to ensure the most actively worked parts of the codebase (I.e. The Hotspots) have Code Coverage while mitigating new technical debt.
Week 1: Establish Baseline & Set Goals
Create Your First Project & Gain Situational Awareness
Create your first CodeScene project
Run an initial analysis
Download a Code Health Overview PDF report (details here)
Subscribe to the weekly Code Health Overview report (details here)
Optimise Your Project Setup Prior to Onboarding
Navigate to the project configuration page to exclude third party code (instructions here)
Configure teams, map aliases and mark ex-developers (instructions here)
Re-run the analysis for updated insights (instructions here)
Nominate Pilot Team(s) and Set a Goal
Nominate one or two teams best placed for achieving the objective of improving Hotspot Code Coverage fast
Open your the Code Coverage dashboard, filter by the team and record their current Hotspot Coverage and set a goal to improve this by 10% in the next 3 months. E.g. Move from 90% Hotspot Coverage to 100% Hotspot Coverage
Good to know: More information on how Code Coverage is calculated in CodeScene can be found here
Share this information internally to communicate the benefits
Week 2: Stabilise the Codebase & Empower Developers
Enable the Pull Request integration with the bare minimum profile to immediately stabilise code quality. (see setup instructions)
Enable the Pull Request integration Code Coverage gates to immediately get notified when coverage is lacking. (details about current support can be found here)
Important: The code coverage gates are currently in Beta stage, and available for opt-in customers on GitHub Cloud only. Contact sales@codescene.com to get early access
Share this 3-Step Developer Onboarding guide with the team(s) for installing the IDE extension and achieving a CodeScene certification
Week 3: Drive Adoption & Address Blockers
Adoption is the foundation for measurable improvement. Address any blockers immediately
Verify 100% of nominated developers have installed the IDE extension and completed the CodeScene Academy courses
Review PR Statistics to check whether feedback is being followed or ignored (instructions here)
Week 4: Bi-weekly Reviews for Staying On Track
Assess team KPIs against your 3-month goal in the Code Coverage Dashboard. On track? Celebrate wins and onboard new teams. Off track? Revisit adoption steps are carried out.
Once more than 80% of code health issues are prevented, activate the Clean Code Collective PR Profile (see in “PR Statistics”)
Week 5: Codebase Stablised & Covered, Let’s Reduce Technical Debt
You've completed the most important onboarding steps to prevent new technical debt and improve Code Coverage where it matters most, great job! Now it’s time to make a real impact.
Refactor the low-hanging fruit: Share this Guided Workflow for Paying Down Technical Debt with the nominated team(s) to help them quickly find the files and functions that once refactored will deliver the greatest return on investment.
Success Insight: Teams that follow this structured approach see measurable code health and code coverage improvements within the first sprint cycle.