Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.99 KB

Contributing to RTVS

Code of Conduct

This project's code of conduct can be found in the CODE_OF_CONDUCT.md file (v1.4.0 of the http://contributor-covenant.org/ CoC).

Contributor License Agreement

If your contribution is large enough, you will be asked to sign the Microsoft CLA (the CLA bot will tell you if it's necessary).

Development

Prerequisites

  1. Visual Studio 2015 Update 1 or higher.
    • You must have C++, Web Tools, and VS Extensibility components (VS SDK) installed.
  2. R 3.2.2 or later; either one of:
  3. Wix Tools 3.10 (only needed if you want to build the installer).

Getting the source code

This repository uses git submodules for some of its dependencies, so you will need to clone it with --recursive command line switch to obtain everything that is needed for a successful build:

git clone --recursive https://github.com/Microsoft/RTVS.git

The remaining dependencies are referenced as NuGet packages, and will be automatically downloaded by VS during the build.

Building and running the product

  1. Open R.sln solution file in Visual Studio.
  2. Set Microsoft.VisualStudio.R.Package as a startup project.
  3. Unload SetupBundle project - it has some internal dependencies, and cannot be built by third parties.
  4. If you are not planning to build the installer MSI (see next section), you can also unload Setup, SetupRHost and SetupCustomActions projects.
  5. Build the solution. Note that this will not build Setup by default.
  6. Start Debugging (F5).
  7. VS experimental instance should start, and you should see "R Tools" entry in the main menu.

Building the installer

  1. Build Setup project specifically (right-click on it in Solution Explorer and select "Build").
  2. Look for the MSI that it generates under bin. Running it will install the product.