Skip to content

Commit a1d296d

Browse files
docs: update contributing guide to remove outdated information and clarify setup instructions
1 parent 82397c9 commit a1d296d

1 file changed

Lines changed: 3 additions & 10 deletions

File tree

docs/contributing.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Prerequisites
44

5-
- .NET 10 SDK (pinned in `global.json` to `10.0.201`)
5+
- .NET 10 SDK
66
- `uv` for the docs site (`brew install uv` or `mise use uv`)
77

88
## Setup
@@ -12,14 +12,12 @@ dotnet tool restore # csharpier + dotnet-api-docs
1212
dotnet restore
1313
```
1414

15-
> **Intility contributors:** `NuGet.config` currently resolves dependencies from `nuget.pkg.github.com/Intility`. Until the package moves to public NuGet, restore needs `NUGET_AUTH_TOKEN` set to a GitHub PAT with `read:packages`.
16-
1715
## Daily Commands
1816

1917
```bash
2018
dotnet build --configuration Release
2119
dotnet test --configuration Release
22-
dotnet csharpier format . # CI fails on unformatted code
20+
dotnet csharpier format .
2321
```
2422

2523
## Docs
@@ -29,8 +27,7 @@ The site is built with mkdocs (Material) and served from GitHub Pages.
2927
```bash
3028
uv venv
3129
uv pip install -r docs/requirements.txt
32-
uv run mkdocs serve # http://127.0.0.1:8000, live reload
33-
uv run mkdocs build --strict # what CI runs; do this before pushing
30+
uv run mkdocs serve
3431
```
3532

3633
If you change C# XML doc comments, regenerate the API reference first:
@@ -74,10 +71,6 @@ Branch names: `feat/`, `fix/`, `refactor/`, `docs/`, `test/`, `chore/`, etc.
7471

7572
Handled by [Release Please](https://github.com/googleapis/release-please). Merging to `main` updates a release PR that accumulates changes. Merging the release PR cuts a GitHub Release, publishes to NuGet, and bumps the version in `JsonApiToolkit.csproj` and `mkdocs.yaml`.
7673

77-
## AI-Assisted Contributions
78-
79-
Project-specific guidance for AI tools lives in `AGENTS.md` at the repo root (with `CLAUDE.md` as a symlink). Update it there if you add conventions other contributors' tools should follow.
80-
8174
## Questions
8275

8376
Open an issue: <https://github.com/intility/Intility.JsonApiToolkit/issues>

0 commit comments

Comments
 (0)