Skip to content

Visual Studio Code extension to capture and explore decision knowledge

License

Notifications You must be signed in to change notification settings

cures-hub/cures-condec-vscode

Repository files navigation

cures-condec-vscode

Continuous integration Codacy Badge Codecoverage GitHub contributors

The ConDec Visual Studio Code extension enables software developers to explore decision knowledge from Visual Studio Code. Decision knowledge covers knowledge about decisions, the problems they address, solution proposals, their context, and justifications (rationale). The software developers can capture decision knowledge in code and commit messages and explore relevant knowledge for code.

Installation

Prerequisites

The following prerequisites are necessary to compile the extension from source code:

Compilation and Packaging

The source code can be compiled within Visual Studio Code. The .vscode folder contains tasks and launch commands that assist in compiling the extension.

To export the extension, navigate into the cures-condec-vscode folder and run:

npm install
vsce package -o cures-condec-vscode.vsix

Download of Precompiled .vsix file

The precompiled .vsix file for the latest release can be found here: https://github.com/cures-hub/cures-condec-vscode/releases/latest

Installation in Visual Studio Code

  • Download or export the cures-condec-vscode.vsix file.
  • Install Visual Studio Code
  • Run code --install-extension cures-condec-vscode.vsix

User Interface and Usage Example

The extension provides a status bar button that will open the currently active code file in the Decision Knowledge Page in Jira, where decision knowledge or other knowledge elements linked to or documented in the code file are shown in different views. The Jira Server URL and the Project Key related to a workspace is stored and can be changed in the workspace settings.

The status bar extension The corresponding knowledge graph, opened in Jira