sourcegraph/doc/dev/index.md

Developing Sourcegraph

This documentation is for developers contributing to the Sourcegraph code base.

Sourcegraph development is open source at:

• GitHub repository
• Issue tracker

Getting started

A hands-on introduction for setting up your local development environment.

• Step 1: Install dependencies
• Step 2: Get the code
• Step 3: Install sg
• Step 4: Start Docker
• Step 5: Initialize your database
• Step 6: Configure HTTPS reverse proxy
• Step 7: Start the server
• Step 8: Additional resources

Background information

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

Overview

• Tech stack
• Security Patterns

Architecture

• Overview
• Introducing a new service

Development

• 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 intelligence
• Developing code insights
• Developing code monitoring
• Developing observability
• Developing Sourcegraph extensions
• 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
• High-performance SQL
• Code host connections on local dev environment

Languages

• Go
• TypeScript
• Bash
• Terraform

Extended guides

• Terraform Extended Guide

Testing

• Continuous Integration
• Testing Principles
• Testing Go code
• Testing web code

Tools

• Renovate dependency updates
• Honeycomb
• Using PostgreSQL

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.

Local development

• How to debug live code
• Set up local development with Zoekt and Sourcegraph
• Ignoring editor config files in Git
• Use golangci-lint

New features

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

Troubleshooting

• Problems with node_modules or Javascript packages
• dial tcp 127.0.0.1:3090: connect: connection refused
• Database migration failures
• Internal Server Error
• Increase maximum available file descriptors.
• Caddy 2 certificate problems
• Running out of disk space
• Certificate expiry
• CPU/RAM/bandwidth/battery usage
• Permission errors for Grafana and Prometheus

Implementing Sourcegraph

• Developing the product documentation
• Observability
  • How to find monitoring
  • How to add monitoring
  • Set up local Sourcegraph monitoring development

Testing Sourcegraph & CI

• How to write and run tests
• Configure a test instance of Phabricator and Gitolite
• Test a Phabricator and Gitolite instance
• Adding or changing Buildkite secrets