|
1 |
| -# Semantic Code Intelligence Protocol (SCIP) |
| 1 | +# SCIP Code Intelligence Protocol |
| 2 | + |
| 3 | +SCIP (pronounciation: "skip") is a language-agnostic protocol |
| 4 | +for indexing source code, |
| 5 | +which can be used to power code navigation functionality |
| 6 | +such as Go to Definition, Find References, and Find Implementations. |
| 7 | + |
| 8 | +This repository includes: |
| 9 | + |
| 10 | +- A [protobuf schema for SCIP](./scip.proto). |
| 11 | +- Rich Go bindings for SCIP: This includes many utility functions |
| 12 | + to help build tooling on top of SCIP. |
| 13 | +- Auto-generated bindings for TypeScript, Rust and Haskell. |
| 14 | +- The [`scip` CLI](#scip-cli-reference) makes SCIP indexes |
| 15 | + a breeze to work with. |
| 16 | + |
| 17 | +<!-- TODO: Link to announcement blog post for "Why SCIP?" |
| 18 | + or copy content from it here once the post is ready. --> |
2 | 19 |
|
3 | 20 | <!--
|
4 | 21 | Workaround: This file is under cmd/ and symlinked from the root
|
@@ -37,6 +54,9 @@ The 'convert' subcommand currently only supports conversion from SCIP to LSIF.
|
37 | 54 |
|
38 | 55 | ## Contributing
|
39 | 56 |
|
40 |
| -See [Development.md](./Development.md). |
| 57 | +We welcome questions, suggestions as well as code and docs contributions. |
| 58 | + |
| 59 | +For submitting contributions, check out [Development.md](./Development.md) |
| 60 | +to better understand project structure and common workflows. |
41 | 61 |
|
42 | 62 | Contributors should abide by the [Sourcegraph Code of Conduct](https://handbook.sourcegraph.com/company-info-and-process/communication/code_of_conduct/).
|
0 commit comments