Developing Sourcegraph
Documentation for developers contributing to the Sourcegraph code base
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, Apple M1 workarounds, ...
Troubleshooting
Help for the most common problems.
Background information
Clarification and discussion about key concepts, architecture, and development stack.
Overview
Architecture
Development
sg- the Sourcegraph developer tool- Developing the web clients
- 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
Extended guides
Testing
Security
Tools
Other
Guidelines
How-to guides
Guides to help with troubleshooting, configuring test instances, debugging, and more.
New features
Implementing Sourcegraph
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