Skip to content

Latest commit

 

History

History
134 lines (81 loc) · 7.38 KB

README.md

File metadata and controls

134 lines (81 loc) · 7.38 KB
Raw

The F# compiler, F# core library, and F# editor tools

Build Status Help Wanted

You're invited to contribute to future releases of the F# compiler, core library, and tools. Development of this repository can be done on any OS supported by .NET.

You will also need .NET SDK installed from here, exact version can be found in the global.json file in the root of the repository.

Contributing

Quickstart on Windows

Build from the command line:

build.cmd

The build depends on an installation of Visual Studio. To build the compiler without this dependency use:

build.cmd -noVisualStudio

After it's finished, open either FSharp.sln or VisualFSharp.sln in your editor of choice. The latter solution is larger but includes the F# tools for Visual Studio and its associated infrastructure.

Quickstart on Linux or macOS

Build from the command line:

./build.sh

After it's finished, open FSharp.sln in your editor of choice.

Documentation for contributors

  • The Compiler Documentation is essential reading for any larger contributions to the F# compiler codebase and contains links to learning videos, architecture diagrams, and other resources.

  • The same docs are also published as The F# Compiler Guide. It also contains the public searchable docs for FSharp.Compiler.Service component.

  • See DEVGUIDE.md for more details on configurations for building the codebase. In practice, you only need to run build.cmd/build.sh.

  • See TESTGUIDE.md for information about the various test suites in this codebase and how to run them individually.

Documentation for F# community

  • The F# Documentation is the primary documentation for F#. The source for the content is here.

  • The F# Language Design Process is the fundamental design process for the language, from suggestions to completed RFCs. There are also tooling RFCs for some topics where cross-community co-operation and visibility are most useful.

  • The F# Language Specification is an in-depth description of the F# language. This is essential for understanding some behaviors of the F# compiler and some of the rules within the compiler codebase. For example, the order and way name resolution happens are specified here, which greatly impacts how the code in Name Resolutions works and why certain decisions are made.

No contribution is too small

Even if you find a single-character typo, we're happy to take the change! Although the codebase can feel daunting for beginners, we and other contributors are happy to help you along.

Not sure where to contribute? Look at the curated list of issues asking for help. If you want to tackle any of those, use the comments section of the chosen issue to indicate interest and feel free to ask for initial guidance. We are happy to help with resolving outstanding issues while making a successful PR addressing the issue.

The issues in this repository can have big differences in the complexity for fixing them. Are you getting started? We do have a label for good first issues as well.

Per-build NuGet packages

7.0.40x series

FSharp.Compiler.Service 43.7.400-preview

<add key="fsharp-prerelease" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet7/nuget/v3/index.json" />

8.0.10x series

FSharp.Compiler.Service 43.8.100-preview

<add key="fsharp-prerelease" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet8/nuget/v3/index.json" />

NOTE: Official NuGet releases of FCS and FSharp.Core are synched with SDK releases (on purpose - we want to be in sync). Nightly packages release to Azure feeds on every successful insertion.

Branches

These are the branches in use:

  • main

    • Almost all contributions go here.
    • Able to be built, installed and used in the latest public Visual Studio release.
    • May contain updated F# features and logic.
    • Used to build nightly VSIX (see above).

  • release/dev15.9

    • Long-term servicing branch for VS 2017 update 15.9.x. We do not expect to service that release, but if we do, that's where the changes will go.

  • release/dev17.x

    • Latest release branch for the particular point release of Visual Studio.
    • Incorporates features and fixes from main up to a particular branch point, then selective cherry-picks.
    • May contain new features that depend on new things or fixes in the corresponding forthcoming Visual Studio release.
    • Gets integrated back into main once the corresponding Visual Studio release is made.

F# language and core library evolution

Evolution of the F# language and core library follows a process spanning two additional repositories. The process is as follows:

  1. Use the F# language suggestions repo to search for ideas, vote on ones you like, submit new ideas, and discuss details with the F# community.
  2. Ideas that are "approved in principle" are eligible for a new RFC in the F# language design repo. This is where the technical specification and discussion of approved suggestions go.
  3. Implementations and testing of an RFC are submitted to this repository.

License

This project is subject to the MIT License. A copy of this license is in License.txt.

Code of Conduct

This project has adopted the Contributor Covenant code of conduct to clarify expected behavior in our community. You can read it at CODE_OF_CONDUCT.

Get In Touch

Members of the F# Software Foundation are invited to the FSSF Slack. You can find support from other contributors in the #compiler and #editor-support channels.

Additionally, you can use the #fsharp tag on Twitter if you have general F# questions, including about this repository. Chances are you'll get multiple responses.

About F#

If you're curious about F# itself, check out these links: