From 5b7b088121f08b2c14a02d42551f754f1877bd87 Mon Sep 17 00:00:00 2001 From: Gauthier Segay Date: Sun, 12 Nov 2023 21:16:42 +0100 Subject: [PATCH] Create DEV_GUIDE.md A bunch of useful notes, and an invitation for more to come. --- DEV_GUIDE.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 DEV_GUIDE.md diff --git a/DEV_GUIDE.md b/DEV_GUIDE.md new file mode 100644 index 0000000000..af4e808c6a --- /dev/null +++ b/DEV_GUIDE.md @@ -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)