Use inline code block as workaround

This commit is contained in:
Greg Van Liew 2020-05-06 11:52:23 -07:00
Родитель b57362862e
Коммит 273e0ba59b
1 изменённых файлов: 3 добавлений и 3 удалений

Просмотреть файл

@ -21,15 +21,15 @@ It was important that we not prescribe overly specific workflows. Instead, our g
## Issues in the code context
Linking to issues in source code is a normal part of our workflow, especially when there's some logic that's difficult to understand or when there's a //TODO comment that needs action. If you do a [search for issue references](https://github.com/microsoft/vscode/search?q=%22Microsoft%2Fvscode%2Fissues%22) in the VS Code repo, you'll see some of them. While linking gives a pointer to more information, to actually learn more you need to leave the editor. Now, by gaining this issue context through hovers, you don't need to break your flow to learn more.
Linking to issues in source code is a normal part of our workflow, especially when there's some logic that's difficult to understand or when there's a //TODO comment that needs action. If you do a [search for issue references](https://github.com/microsoft/vscode/search?q=%22Microsoft%2Fvscode%2Fissues%22) in the VS Code repo, you'll see plenty of issues mentioned. While linking gives a pointer to more information, to actually learn more you need to leave the editor. Now, by gaining this issue context through hovers, you don't need to break your flow to learn more.
![Issue Hover](issue-hover.png)
Issue hovers work on full issue URLs, issue comment URLs, issues referenced by number (#1234), and issues referenced by owner/repository#1234 (for example Microsoft/vscode#1234). We also often reference users in our codebase. The VS Code [proposed API](https://github.com/microsoft/vscode/blob/d8317abc50e347d76fd471f5a070996cc7f73e20/src/vs/vscode.proposed.d.ts) has many developer references to make it obvious who's responsible for the proposals.
Issue hovers work on full issue URLs, issue comment URLs, issues referenced by number (`#1234`), and issues referenced by `owner/repository#1234` (for example `Microsoft/vscode#1234`). We also often reference users in our codebase. The VS Code [proposed API](https://github.com/microsoft/vscode/blob/d8317abc50e347d76fd471f5a070996cc7f73e20/src/vs/vscode.proposed.d.ts) has many developer references to make it obvious who's responsible for the proposals.
![User Hover](user-hover.png)
Issue context is typically needed in commit messages to reference an issue the commit resolves, within source code files, and in Markdown (such as a changelog). To easily add this context, we have added completion suggestions for issues and users. In the Git commit textbox, you can format your issue completion with the `githubIssues.issueCompletionFormatScm` setting. In Markdown files, issues complete as a Markdown link, and in other files, issues complete as a simple issue number (#1234).
Issue context is typically needed in commit messages to reference an issue the commit resolves, within source code files, and in Markdown (such as a changelog). To easily add this context, we have added completion suggestions for issues and users. In the Git commit textbox, you can format your issue completion with the `githubIssues.issueCompletionFormatScm` setting. In Markdown files, issues complete as a Markdown link, and in other files, issues complete as a simple issue number (`#1234`).
![Completion Suggestions](completion-suggestions.gif)