Getting Started

Welcome to BrowserStack Code Quality. This page helps first‑time users quickly become productive and adopt good daily habits.

Overview

BrowserStack Code Quality analyzes your repositories, flags issues, and tracks trends across code health, security, reliability, and maintainability. You interact with the platform through dashboards, project pages, issue views, and reports.

Prerequisites

Before you begin, make sure:

• Your account or SSO access is provisioned.
• At least one repository has been connected and scanned.
• Your role (Administrator, Manager, Analyst, Explorer) is understood (see Access Control documentation).

Quick Start Workflow

1. Sign in (credentials or SSO).
2. Open the Dashboard to see latest scan summaries.
3. Drill into a project: select the repository card.
4. Pick the latest scan run (or compare two runs).
5. Review high severity issues first; assign or triage.
6. Generate a report if stakeholders need a snapshot.
7. Set notifications to stay informed on new critical findings.

Navigating the Interface

Dashboard

Shows: aggregated quality score, recent scan status, top severity issues, trending metrics. Customize widgets to focus on what matters to your team.

Projects & Repositories

From the Projects view you can:

• Switch between repositories.
• View scan history and timestamps.
• Filter by branch (e.g., main vs feature branches).
• Spot trend lines (improving vs regressing quality).

Issue Explorer

Use filters (severity, category, rule tag, status, assignee) and search. Bulk actions allow assignment or suppression (with justification). Always review suppressions during code reviews.

Core Features

Custom Dashboards

Create dashboards per team or initiative (e.g., Security Focus, New Code Quality). Add, reorder, resize widgets. Export a snapshot for presentations. → See: Creating a Dashboard

Issue Management

Key actions:

• Filter & search precisely.
• Assign with due dates or SLA notes.
• Suppress false positives (document rationale).
• Track resolution progress (open → in progress → fixed → verified). → See: Issue Management

Quality Badges

Embed a badge in README or internal portals to reflect current quality score and build trust. → See: Badges

Viewing Analysis Results

1. Open the repository.
2. Select a scan from history (use compare for deltas).
3. Apply severity filters (start with Critical & High).
4. Expand an issue to see rule rationale and remediation guidance.
5. Jump to file context via code snippet preview or IDE plugin link.

Creating Reports

Reports summarize metrics (issues by severity/category, trend lines, coverage, rule adoption). Typical use cases:

• Sprint review quality snapshot.
• Release readiness (quality gate pass/fail).
• Executive overview (risk + improvement trajectory). You can export as PDF/CSV or share a permalink. → See: Reports

Notifications & Alerts

Configure notifications for:

• Scan completion.
• Quality gate failure (new code or overall).
• New Critical issues.
• Regression in key metrics (e.g., security score drop >5%). Prefer channel integrations (e.g., email, Slack) for team awareness.

Best Practices

• Triage daily; keep backlog of High/Critical issues small.
• Fix new code issues before merging to prevent accumulation.
• Periodically audit suppressed issues for accuracy.
• Use dashboards to make improvements visible; celebrate reductions.
• Align reports with sprint and release cadences.

Troubleshooting

Scenario	What to Check	Action
Missing repository	Access permissions	Re-sync or reconnect via settings
No new scans	CI pipeline trigger	Confirm webhook or manual scan schedule
Badge not updating	Cache / branch mismatch	Verify badge URL branch parameter
Too many false positives	Rule profile tuning	Adjust profile; document changes

Help & Support

• Browse full documentation.
• Review FAQs for common setup questions.
• Contact your administrator for access or configuration issues.
• Reach out to support for technical problems or rule clarifications.

Next Steps

• Create a custom dashboard.
• Establish an issue triage routine.
• Generate a stakeholder report.
• Configure quality gate notifications.

Continue: Dashboards · Issues · Reports