Getting Started Guide For New Users
1. Installation (On-Premise customers only)
Install CodeScene & Activate your license
Subscribe here to On-Premise Release Announcements
2. Create Your First Project
Set up 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)
Explore the analysis results in the dashboard
3. Optimise Your Project Setup
Exclude 3rd party code (instructions here)
Configure teams, map aliases and mark ex-developers (instructions here)
Re-run the analysis for updated insights (instructions here)
Review Knowledge Distribution → Code Familiarity to identify key knowledge holders
4. Pull Request Integration (Stabilise the Codebase)
Enable the Pull Request integration with the minimum profile (see setup instructions)
Submit your first PR for review and receive automated feedback
5. Developer Onboarding
Install CodeScene’s IDE Extension to get real-time feedback before commits
Enrol in CodeScene Academy and complete the Developer Training courses
Watch Adam Tornhill’s Presentation: “Writing Code for the Human Brain: Optimize Code for Cognitive Bottlenecks”
This enables your development team to understand the CodeHealth metric and the feedback they receive in their IDE and Pull Requests
6. Track Adoption
Verify that all developers have installed the IDE extension
Review PR Statistics to check whether feedback is being followed or ignored (instructions here)
7. Pull Request Review – Raise the Bar
Once more than 80% of code health issues are prevented, activate the Clean Code Collective PR Profile (see in “PR Statistics”)
This raises your quality standard and enforces cleaner, more maintainable code