Skip to content

Latest commit

 

History

History
58 lines (48 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

58 lines (48 loc) · 1.79 KB
Raw

How to contribute

Prerequisites

Building

Fork, from the github interface https://github.com/ionide/ionide-vscode-fsharp

  • if you don't use a certificate for commiting to github:
git clone https://github.com/YOUR_GITHUB_USER/ionide-vscode-fsharp.git
  • if you use a certificate for github authentication:
git clone [email protected]:YOUR_GITHUB_USER/ionide-vscode-fsharp.git

First time build:

cd ionide-vscode-fsharp
yarn install
dotnet restore
cd src
dotnet restore
cd ..
./build.sh  # or build.cmd if your OS is Windows

Everything is done via build.cmd \ build.sh.

  • build Build does a full-build, including package installation and copying some necessary files.
    It should always be done at least once after any clone/pull.
  • If a git dependency fail to build paket won't re-do it you can run their build scripts manually:
    • In paket-files\github.com\fsharp\FsAutoComplete run build LocalRelease
    • In paket-files\github.com\fsharp-editing\Forge run build Build
  • In VSCode two configurations are possible to run:
    • Use Build and Launch Extension
    • Start the Watch task and when a build is done start Launch Only

Working with FSAC

  1. Run build.cmd Build \ build.sh Build
  2. Open Ionide-vscode-fsharp in VSCode.
  3. Set devMode to true in src/Core/LanguageService.fs
  4. Open FSAC in VS
  5. Start FSAC.Suave in VS
  6. Press F5 in VSCode to build Ionide and start experimental instance