Skip to content

Commit 110c3ce

Browse files
committed
docs: update playground types
Update the contribution guide, as this is what CI does, so we should do that here too.
1 parent f4391d7 commit 110c3ce

File tree

11 files changed

+25
-13
lines changed

11 files changed

+25
-13
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,25 @@ pnpm migrate
2121
There are a number of automated checks which run on GitHub Actions when a pull request is created.
2222
You can run those checks on your own locally to make sure that your changes would not break the CI build.
2323

24-
### 1. Check the code for JavaScript style violations
24+
### 1. Rebuild the generated files
25+
26+
```sh
27+
pnpm gen
28+
```
29+
30+
### 2. Check the code for JavaScript style violations
2531

2632
```sh
2733
pnpm lint
2834
```
2935

30-
### 2. Check the code for Ruby style violations
36+
### 3. Check the code for Ruby style violations
3137

3238
```sh
3339
bin/rubocop
3440
```
3541

36-
### 3. Run the test suite
42+
### 4. Run the test suite
3743

3844
```sh
3945
bin/rspec

playground/vanilla/app/frontend/types/serializers/Composer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// TypesFromSerializers CacheKey b379726b6fef2dadbfd614384b868746
1+
// TypesFromSerializers CacheKey c5f5056c4fa3626c5c1908d0f1dcfe8d
22
//
33
// DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
44

playground/vanilla/app/frontend/types/serializers/ComposerWithSongs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// TypesFromSerializers CacheKey 9111c6d881174b0013582fa6366868db
1+
// TypesFromSerializers CacheKey acbbfcd258be7c495d2784be9b815e79
22
//
33
// DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
44
import type ComposerWithSongsSong from './ComposerWithSongs/Song'

playground/vanilla/app/frontend/types/serializers/ComposerWithSongs/Song.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// TypesFromSerializers CacheKey a69c0dbcc904740e5de89181ef4b2837
1+
// TypesFromSerializers CacheKey b8af6beb071f45e87fe53318043f5388
22
//
33
// DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
44

playground/vanilla/app/frontend/types/serializers/Model.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// TypesFromSerializers CacheKey ed8ff6fbc986e6b666d559749c666dc5
1+
// TypesFromSerializers CacheKey 89c74246c39a38f244b708597ef3b884
22
//
33
// DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
44
import type AnyModel from '../AnyModel'

playground/vanilla/app/frontend/types/serializers/Nested/Album.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// TypesFromSerializers CacheKey 58897b61d86838c60d1f12700f326896
1+
// TypesFromSerializers CacheKey ddc921e1e92a90ea686336285fcdb369
22
//
33
// DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
44
import type AnyModel from '../../AnyModel'

playground/vanilla/app/frontend/types/serializers/SnakeComposer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// TypesFromSerializers CacheKey 89e5760366d01f7f21244d341e1af2d4
1+
// TypesFromSerializers CacheKey 03a6c67042bb201dfeeab4b021db7dd5
22
//
33
// DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
44

playground/vanilla/app/frontend/types/serializers/Song.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// TypesFromSerializers CacheKey f4f9e398dc092747d13607e2bdcb0846
1+
// TypesFromSerializers CacheKey c2c60f7c58d2fbafd49219bd8673dd15
22
//
33
// DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
44
import type Composer from './Composer'

playground/vanilla/app/frontend/types/serializers/SongWithVideos.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// TypesFromSerializers CacheKey c2d167325e7342eba01d0a78482d6d76
1+
// TypesFromSerializers CacheKey e6174fbd5fbf2c871782886b3b441101
22
//
33
// DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
44
import type Composer from './Composer'
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// TypesFromSerializers CacheKey 45d6b515fb6118eabbd39d586269cdd0
1+
// TypesFromSerializers CacheKey fa77137240a406b724863f5d51e9c3e4
22
//
33
// DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
44

@@ -7,6 +7,9 @@ export default interface Video {
77
createdAt: string | Date
88
title?: string
99
untypedFieldExample: any
10+
/**
11+
* YouTube ID of the video
12+
*/
1013
youtubeId?: string
1114
youtubeUrl?: string
1215
}

0 commit comments

Comments
 (0)