Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 2.2 KB

Contribution Guide

Guidelines

  • If the existing tests do not already cover your changes, please add tests.

Building the Sources

To build the plugin sources, please follow these steps:

  1. Clone the code from git.
  2. Download the JFrog CLI executable for Windows and place it under $PROJECT_LOCATION\JFrogVSExtension\Resources.
  3. Open Visual Studio.
  4. Open Tools --> Get Tools and Features

alt

  1. Select the workloads tab and scroll to the bottom for the Other Toolsets section. Install Visual Studio extension development. Read more about Visual Studio SDK here.

alt

  1. Once the installation is completed, re-open Visual Studio.
  2. Click on File --> Open --> Project/Solution and navigate to the project root dir and select the sln file.
  3. To build the project, click on Build tab --> Build Solution. The VSIX file will be created in the following location: $PROJECT_LOCATION\bin\Release\JFrog.VSExtension.vsix
  4. If the build fails, please refer to the Troublshooting Issues section.

alt

  1. If you'd like to help us develop and enhance the extension, this step is for you. To build and run the plugin following your code changes, click on Debug --> Start Debugging.

alt

Run the tests

After build has finished successfuly, you can run the tests using:

  1. Visual Studio Test Explorer - click on Test -> Run All Tests.
  2. Command line interface - navigate to the tests folder /UnitTestJfrogVSExtension/bin/{Release/Debug} and then run the following command:
dotnet test .\UnitTestJfrogVSExtension.dll

Troublshooting Issues

When openning the project in Visual Studio for the first time, the following error may appear : "Fody.WeavingTask" task was not given a value for the required parameter "SolutionDir".

To fix this,close the solution and open it again. More information can be found here