F# Compiler Guide
About
The release notes for the F# language, FSharp.Core and FSharp.Compiler.Service are based on the Keep a Changelog format.
The target audience of these release notes are the respective end-users.
Writing a changelog entry
In order to keep the change logs consistent the following format was proposed for each entry:
|
Some tips:
- Use valid Markdown.
- Use
*as bullet point symbol. We don't want to mix*and-. - Start your description with a capital and end the sentence with a dot.
- Always include a link to your pull request before the closing
),([PR #16106](https://github.com/dotnet/fsharp/pull/16106)). - Optionally, include a link to an issue on
dotnet/fsharpuseIssue #numberbefore the link to the pull request.
Example:
|
- Optionally, include a link to a language suggestion from
dotnet/fsharpuseLanguage suggestion #numberbefore the link to the pull request.
Example:
|
- Choose the right section for your type of change. (
## Added,## Changed,## Deprecated,## Removed,## Fixedor## Security). - Ensure your description makes it clear what the change is about. The reader should be informed on a high level without needing to click through the pull request link and find out in the code what actually changed.
- Maintainers or other contributors might rewrite your changelog entry in the future. This might be done when multiple pull requests can be consolidated under the same umbrella.
- Related pull requests can be listed in the same entry when it makes sense.
Example:
|
The release process
General
How does it work? Different stages/phases?
FSharp.Compiler.Service
Perhaps add some specific info if available?