|
| 1 | +# Coding Agent Guidelines |
| 2 | + |
| 3 | +## Testing |
| 4 | + |
| 5 | +Add comprehensive tests for all new features. Tests are located in `tests/`: |
| 6 | + |
| 7 | +- `FSharp.Data.Core.Tests/` - Core functionality tests (CSV, JSON, HTML, XML parsers) |
| 8 | +- `FSharp.Data.DesignTime.Tests/` - Type provider design-time tests |
| 9 | +- `FSharp.Data.Tests/` - Integration and end-to-end tests |
| 10 | +- `FSharp.Data.Reference.Tests/` - Reference/signature tests |
| 11 | + |
| 12 | +Match test style and naming conventions of existing tests in the appropriate project. |
| 13 | + |
| 14 | +## Code Formatting |
| 15 | + |
| 16 | +Run Fantomas before committing: |
| 17 | + |
| 18 | +```bash |
| 19 | +dotnet run --project build/build.fsproj -t Format |
| 20 | +``` |
| 21 | + |
| 22 | +To check formatting without modifying files: |
| 23 | + |
| 24 | +```bash |
| 25 | +dotnet run --project build/build.fsproj -t CheckFormat |
| 26 | +``` |
| 27 | + |
| 28 | +## Build and Test |
| 29 | + |
| 30 | +Build the solution: |
| 31 | + |
| 32 | +```bash |
| 33 | +./build.sh |
| 34 | +# or |
| 35 | +dotnet run --project build/build.fsproj -t Build |
| 36 | +``` |
| 37 | + |
| 38 | +Run all tests: |
| 39 | + |
| 40 | +```bash |
| 41 | +dotnet run --project build/build.fsproj -t RunTests |
| 42 | +``` |
| 43 | + |
| 44 | +Run everything (build, test, docs, pack): |
| 45 | + |
| 46 | +```bash |
| 47 | +dotnet run --project build/build.fsproj -t All |
| 48 | +``` |
| 49 | + |
| 50 | +## Documentation |
| 51 | + |
| 52 | +Documentation lives in `docs/`. Update relevant docs when adding features: |
| 53 | + |
| 54 | +- `docs/library/` - API and provider documentation |
| 55 | +- `docs/tutorials/` - Tutorial content |
| 56 | + |
| 57 | +Generate and preview docs: |
| 58 | + |
| 59 | +```bash |
| 60 | +dotnet run --project build/build.fsproj -t GenerateDocs |
| 61 | +``` |
| 62 | + |
| 63 | +## Release Notes |
| 64 | + |
| 65 | +Update `RELEASE_NOTES.md` at the top of the file for any user-facing changes. Follow the existing format: |
| 66 | + |
| 67 | +```markdown |
| 68 | +## X.Y.Z - Date |
| 69 | + |
| 70 | +- Description of change by @author in #PR |
| 71 | +``` |
0 commit comments