Skip to content

Commit 06e7467

Browse files
committed
Update README with contributing guide and OpenAPI CI note
Expand the Contributing section with step-by-step instructions including the OpenAPI regeneration step. Add a note to the OpenAPI section about the CI drift check. https://claude.ai/code/session_01F4qY2LA6JYqsvdLi4xkLVA
1 parent c635ab1 commit 06e7467

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,32 @@ OPENAPI=1 bundle exec rspec
121121
This merges actual API responses into `docs/openapi.yml`. Hand-written component
122122
schemas are preserved. Review the diff and commit the result.
123123

124+
> [!NOTE]
125+
> CI will fail if `docs/openapi.yml` is out of date. Always regenerate and
126+
> commit the spec when changing API endpoints or serializers.
127+
124128
## Contributing
125129

126-
Contribution directions go here.
130+
1. Fork the repo and create your branch from `main`.
131+
2. Install dependencies:
132+
```bash
133+
bundle install
134+
```
135+
3. Run the test suite:
136+
```bash
137+
bundle exec rake
138+
```
139+
4. If you changed any API endpoints or serializers, regenerate the OpenAPI spec:
140+
```bash
141+
OPENAPI=1 bundle exec rspec
142+
```
143+
Review the diff in `docs/openapi.yml` and include it in your commit. CI will
144+
reject PRs where the spec is out of date.
145+
5. Ensure linting passes:
146+
```bash
147+
bundle exec standardrb
148+
```
149+
6. Open a pull request.
127150

128151
## License
129152

0 commit comments

Comments
 (0)