FSharp.Formatting is primarily maintained through agentic development under human guidance. Maintainers discuss proposed work and then direct coding agents to make the complete change, including implementation, tests, documentation, samples, and other affected files.
We generally prefer contributions as GitHub issues rather than pull requests. Search for an existing report first. Issues may include proposed changes, patches, or links to forks or branches. Maintainers may refine the scope and assign the issue to an agent to implement and validate the complete change.
Repo Assist is an automated AI assistant that runs regularly in this repository. It may triage or respond to issues, investigate bugs, suggest improvements, and attempt implementations as draft pull requests. Its work is identified as automated and remains subject to human review; Repo Assist does not merge pull requests or make final maintenance decisions.
Maintainers can invoke Repo Assist with /repo-assist <instructions> for a specific agentic task,
such as investigating an issue, preparing a fix, adding tests, or updating documentation.
Every pull request must have a matching issue that has been discussed with the maintainers. Link the pull request to that issue and keep it focused. Maintainers may close a pull request and use the issue as the basis for an agent-produced implementation instead; the submitted analysis and code remain valuable inputs to that work.
- Clone the repository
- Build with
dotnet build - Open
FSharp.Formatting.slnwith Visual Studio or Visual Studio Code (with the ionide-fsharp extension)
The tool can build its own documentation from the docs folder of this repository:
dotnet run --project src/fsdocs-tool -- watch
dotnet run --project src/fsdocs-tool -- build --clean
Run
dotnet fsi build.fsx -- --help
to see what other pipelines can be run from build.fsx.
dotnet fsi build.fsx -- -p Verify
Will perform the linting, unit tests and analyzer check. This is useful to run locally before submitting your PR.
This repository uses the Fantomas source code formatter and this is checked on commit.
Run
dotnet fantomas src tests docs build.fsx -r
to format the code you've written.