|
1 |
| -# (experimental) Sourcegraph extension for code discussions |
| 1 | +# Sourcegraph Code Discussions <em><sub><br/> — discuss code contextually, review code continuously.</sub></em> |
2 | 2 |
|
3 |
| -This extension for Sourcegraph lets you see code discussions inline on Sourcegraph and on GitHub.com. |
| 3 | +- 🖥️ Write comments on code while browsing on Sourcegraph.com. |
| 4 | +- 🧠 Discover discussions and existing knowledge on GitHub & Sourcegraph while browsing code. |
| 5 | +- 🤔 Review code continuously, not just in Pull Requests. |
| 6 | +- 🤲 Share knowledge & help unblock team members. |
4 | 7 |
|
5 |
| - |
| 8 | +## ⚡ Experimental warning |
| 9 | + |
| 10 | +Code Discussions is an experiment [by Sourcegraph](https://about.sourcegraph.com/about). It is not yet ready for widespread production use. |
| 11 | + |
| 12 | +If you're as excited about improving how code is discussed as much as we are, then please try it out, [give us feedback and file issues](https://github.com/sourcegraph/issues/issues), and reach out to us (hi@sourcegraph.com). We'd love to hear from you! |
| 13 | + |
| 14 | +## GitHub integration |
| 15 | + |
| 16 | +This shows how you can view previously created discussions on GitHub.com while browsing code: |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +> Note: Clicking them will bring you to Sourcegraph, it is not yet possible to create or reply to discussions on GitHub itself. We hope to support this soon. |
| 21 | +
|
| 22 | +## Getting started |
| 23 | + |
| 24 | +1. [Set up a Sourcegraph server](https://about.sourcegraph.com/docs) (soon you will be able to use this on open source repositories via Sourcegraph.com). |
| 25 | +2. Visit the **extensions** page (link in the top right / navbar of Sourcegraph) and enable this extension. |
| 26 | +3. Visit any file in any repository, select a line by clicking it and then create a discussion by clicking the chat icon that appears. |
| 27 | + |
| 28 | +For the GitHub integration: |
| 29 | + |
| 30 | +1. Install [Sourcegraph for Chrome](https://chrome.google.com/webstore/detail/sourcegraph/dgjhfomjieaadpoljlnidmbgkdffpack) or [Sourcegraph for Firefox](https://addons.mozilla.org/en-US/firefox/addon/sourcegraph/) |
| 31 | +2. Open the Sourcegraph for Chrome/Firefox extension options page (by clicking the Sourcegraph icon in the browser toolbar) |
| 32 | +3. Check the box labeled **Use Sourcegraph extensions** (required while this feature is in alpha) |
| 33 | + |
| 34 | +## Coming soon: Visual Studio Code integration |
| 35 | + |
| 36 | +This shows how you can view, create, and reply to discussions right from your editor: |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +> Note: This integration is not yet released. See [sourcegraph/sourcegraph-vscode#15](https://github.com/sourcegraph/sourcegraph-vscode/pull/15) for tracking this integration. |
0 commit comments