index.md

Developing Sourcegraph

<style> .markdown-body h2 { margin-top: 2em; } .markdown-body ul { list-style:none; padding-left: 1em; } .markdown-body ul li { margin: 0.5em 0; } .markdown-body ul li:before { content: ''; display: inline-block; height: 1.2em; width: 1em; background-size: contain; background-repeat: no-repeat; background-image: url(../batch_changes/file-icon.svg); margin-right: 0.5em; margin-bottom: -0.29em; } body.theme-dark .markdown-body ul li:before { filter: invert(50%); } </style>

Documentation for developers contributing to the Sourcegraph code base

★ Quickstart: develop Sourcegraph on your machine GitHub repository Issue Tracker

Setup

Learn how to develop Sourcegraph on your machine.

★ Quickstart
Run through the step by step guide and get your local environment ready. How-to guides
Context specific guides: debugging live code Troubleshooting
Help for the most common problems.

Background information

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

Architecture

• Overview
• Introducing a new service

Development

• sg - the Sourcegraph developer tool
• Using Bazel
  • Bazel and Go code
  • Bazel and client code
  • Bazel and container images
  • Bazel FAQ
  • Writing a server integration test
• 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 the SCIM API
• Developing batch changes
• Developing code intelligence
• 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
• Testing
  • Testing principles and guidelines
  • Continuous integration
  • How to write and run tests
    • Testing Go code
    • Testing web code
• Building p4-fusion
• The gitserver API
• Using gRPC alongside REST for internal APIs

Git

• git gc and its modes of operations in Sourcegraph

Languages

• Tech stack
• Go
  • Error handling in Go
• TypeScript
• Bash
• Terraform

SQL

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

Security

• Security patterns
• Security policy
• How to disclose vulnerabilities.
• CSRF security model
• Sourcegraph secret formats

Testing

• Continuous integration
• Testing a pull request
• Testing principles
• Testing Go code
• Testing web code
• Code host test plans

Tools

• Renovate dependency updates
• Honeycomb
• GoLand
• Wolfi overview

Other

• Telemetry
• Adding, changing and debugging pings
• DEPRECATED: Event level data usage pipeline
• DEPRECATED: Adding, changing and debugging user event data
• Deploy Sourcegraph with Helm chart (BETA)
• GitHub API oddities

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

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

• Open source FAQ
• Code of conduct
• Project setup and CI checks for frontend issues
• Accepting an external contribution guide