Skip to content

Commit

Permalink
Merge pull request #4234 from smoothdeveloper/patch-3
Browse files Browse the repository at this point in the history
Create DEV_GUIDE.md
  • Loading branch information
forki authored Nov 14, 2023
2 parents 06634cf + 5b7b088 commit b7e10f8
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions DEV_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Notes about development in this repository

Please contribute any notes that made your contributions easier here.

Note that historically, the bulk of the development occured on Windows before dotnet got cross platform, for now, the tooling to target .NET Framework is still required for some areas.

# Notes about the Paket F# Interactive extension

Some pointers to help efforts to foster the F# Interactive extension ecosystem:

* integrations in IDEs:
* Rider: take inspiration from [how Rider does autocomplete for nuget package in `#r "nuget: "`](https://github.com/JetBrains/resharper-fsharp/pull/539)
* Ionide setting to [use FSAC path to pass as an extra `--compilertool:` argument to FSI](https://github.com/ionide/ionide-vscode-fsharp/pull/1959)
* Proposal to [ship the paket extension with FSAC](https://github.com/fsharp/FsAutoComplete/pull/1198)
* keeping the documentation refering to the extensions mechanism in shape:
* [F# Interactive options](https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/fsharp-interactive-options)
* [F# Interactive options](https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/fsharp-interactive-options)
* [Paket extension documentation](https://github.com/fsprojects/Paket/blob/master/docs/content/fsi-integration.md)
* [Documentation about extensions (https://aka.ms/dotnetdepmanager)](https://github.com/dotnet/fsharp/blob/main/src/FSharp.DependencyManager.Nuget/README.md)
* Discussion about a [stable location / mechanism so extensions are loaded in a single place by all tooling and variants of F# Interactive](https://github.com/dotnet/fsharp/issues/8880)

# Updates to support new major SDK releases

This is overall a stress free process, you can take example on previous PRs:

* [dotnet 8](https://github.com/fsprojects/Paket/pull/4219)
* [dotnet 7](https://github.com/fsprojects/Paket/pull/4219](https://github.com/fsprojects/Paket/commit/c6e1bd1b67f26ce29417cd853425ccf33fc067c0)
* [dotnet 6](https://github.com/fsprojects/Paket/pull/4013)
* [dotnet 4.8.1](https://github.com/fsprojects/Paket/pull/4227)

0 comments on commit b7e10f8

Please sign in to comment.