Skip to content

Commit c89b3f8

Browse files
committed
add agents.md
1 parent e3e0b00 commit c89b3f8

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Agent Guidelines
2+
3+
## Release Notes
4+
5+
Update `RELEASE_NOTES.md` when making user-visible changes:
6+
- Add entries under the `## [Unreleased]` section
7+
- Use categories: `### Added`, `### Changed`, `### Fixed`, `### Removed`
8+
- Include PR links: `[#123](https://github.com/fsprojects/FSharp.Formatting/pull/123)`
9+
10+
## Code Formatting
11+
12+
Format code using Fantomas before committing:
13+
14+
```bash
15+
dotnet tool restore
16+
dotnet fantomas build.fsx src tests docs
17+
```
18+
19+
Check formatting without modifying files:
20+
21+
```bash
22+
dotnet fantomas build.fsx src tests docs --check
23+
```
24+
25+
Configuration is in `.editorconfig`.
26+
27+
## CI Checks
28+
29+
Run these checks locally before pushing:
30+
31+
```bash
32+
# Full CI pipeline (lint, build, test, docs)
33+
dotnet fsi build.fsx
34+
35+
# Just lint and test
36+
dotnet fsi build.fsx -- -p Verify
37+
38+
# Run analyzers (G-Research.FSharp.Analyzers, Ionide.Analyzers)
39+
dotnet msbuild /t:AnalyzeSolution
40+
```
41+
42+
Individual steps:
43+
44+
```bash
45+
dotnet restore FSharp.Formatting.sln
46+
dotnet build FSharp.Formatting.sln --configuration Release
47+
dotnet test FSharp.Formatting.sln --configuration Release --no-build
48+
```

0 commit comments

Comments
 (0)