Developing Sourcegraph

Documentation for developers contributing to the Sourcegraph code base

Setup

Learn how to develop Sourcegraph on your machine.

Background information

Clarification and discussion about key concepts, architecture, and development stack.

Overview

• Tech stack
• Current Sourcegraph tech radar (also see how to maintain the radar)

Architecture

• Overview
• Introducing a new service

Development

• sg - the Sourcegraph developer tool
  • Full sg reference
• Developing the web clients
  • Developing the web app
  • Developing the code host integrations
  • Working with GraphQL
  • Wildcard Component Library
  • Styling UI
  • Accessibility
  • Temporary settings
  • Build process
• Developing the GraphQL API
• Developing batch changes
• Developing code navigation
• Developing code insights
• Developing code monitoring
• Developing observability
• Dependencies and generated code
• Code reviews
• Commit messages
• Exposing services
• Developing a store
• Developing a worker
• Developing an out-of-band migration
• Developing a background routine
• Code host connections on local dev environment
• Testing
  • Testing principles and guidelines
  • Continuous integration
  • How to write and run tests
    • Testing Go code
    • Testing web code
• Building p4-fusion

Languages

• Go
• TypeScript
• Bash
• Terraform

SQL

• Using PostgreSQL
• Migrations
• High-performance guides
  • Batch operations
  • Materialized cache

Security

• Security Patterns
• Security policy
• How to disclose vulnerabilities.
• CSRF security model

Tools

• Renovate dependency updates
• Honeycomb
• GoLand

Other

• Telemetry
• Adding, changing and debugging pings

Guidelines

• Code reviews
• Open source FAQ
• Code of conduct

How-to guides

Guides to help with troubleshooting, configuring test instances, debugging, and more.

New features

• How to add support for a language
• How to use feature flags
• How to add caching

Observability

• How to add observability
• How to add logging
• How to find monitoring
• How to add monitoring
• Set up local monitoring development
• Set up local OpenTelemetry development

Plans and licenses

• How to generate a license key for testing and debugging

Documentation

• Developing the product documentation
• Architecture Decision Records (ADRs)

Executors

• How to deploy a new executor image

Testing

• How to write and run tests
• Run a local Sourcegraph instance behind ngrok
• Testing against code hosts
  • Configure a test instance of Phabricator and Gitolite
  • Test a Phabricator and Gitolite instance
  • Sync repositories from gitolite.sgdev.org

Contributing

• Project setup and CI checks for frontend issues.
• Accepting an external contribution guide.