Skip to content

Commit 7c4d0b7

Browse files
committed
Fix CONTRIBUTING conflict
1 parent 92aa5fc commit 7c4d0b7

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ For issue reporting, use [Github Issues](https://github.com/ionide/ionide-vscode
1212
- [Submitting **Bug Reports**](#bug-reports)
1313
- [Submitting **Feature Requests**](#feature-requests)
1414

15-
Personal support request should be discussed on [F# Software Foundation Slack](https://fsharp.org/guides/slack/).
15+
Personal support request (or getting contribution help) should be discussed on [F# Software Foundation Slack](https://fsharp.org/guides/slack/) or [the F# Discord](https://discord.gg/R6n7c54).
1616

1717
## Getting Started
1818

@@ -131,11 +131,21 @@ Note: Step 1 starts a new "Watch" task that rebuilds Ionide in the background wh
131131

132132
If you're curious what's going on, you can view the log output for this task by running `Tasks: Show Running Tasks` from the command palette.
133133

134-
### Working with FSAC
134+
### Working with FSAC (FSharpAutoComplete)
135+
Most Ionide bugs are actually from there. This repo only stores the glue code between FSAC and Visual Studio Code - not the actual implementation of behaviours you would experience when using Ionide in Visual Studio Code which are implemented in FSAC.
136+
1. **Fork the FSAC repo** https://github.com/fsharp/FsAutoComplete on github.
135137

136-
1. Open FSAC from a new instance of VSCode from the directory: `paket-files/github.com/fsharp/FsAutoComplete`
137-
2. Build the FSAC solution and copy the dll output from the output log, it should be something like: `paket-files/github.com/fsharp/FsAutoComplete/src/FsAutoComplete/bin/Debug/net5.0/fsautocomplete.dll`.
138-
3. In the instance of VSCode that you have Ionide open, open settings (`CMD ,` or `Ctrl ,`), and find the section `FSharp > Fsac: Net Core Dll Path` and paste the output you copied from step 3.
138+
1. **Clone your fork**:
139+
```bash
140+
git clone [email protected]:YOUR_GITHUB_USER/FsAutoComplete.git
141+
```
142+
or if you don't use ssh:
143+
144+
```bash
145+
git clone https://github.com/YOUR_GITHUB_USER/FsAutoComplete.git
146+
```
147+
2. Follow the [FSAC build instructions](https://github.com/fsharp/FsAutoComplete#building-and-testing) and copy the dll output from the output log, it should be a path inside the FSAC repo ending with `src/FsAutoComplete/bin/Release/net6.0/fsautocomplete.dll`. (Alternatively, delete the `net6.0/fsautocomplete.dll` part and it will also work.) Note that `Release` may be substituted with `Debug` if you build with that configuration instead. Also, note that `net6.0` may be replaced with another .NET version like `net7.0` as FsAutoComplete targets a newer .NET version.
148+
3. In the instance of VSCode that you have Ionide open, open settings (`CMD ,` or `Ctrl ,` by default), and find the section `FSharp > Fsac: Net Core Dll Path` and paste the output you copied from step 3.
139149
4. Now find the section `FSharp > Fsac: Attach Debugger` and check the check box.
140150
5. Close settings
141151
6. Goto the debug section and hit `Build and Launch extension`, after a while another instance of VSCode will start, you can use this instance to test Ionide/FsAutoComplete.

0 commit comments

Comments
 (0)