Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Commit 4f85634

Browse files
committed
Document sample naming convention
1 parent bce0e66 commit 4f85634

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/contribute/create_sample.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Create a sample bundle
22

3-
Create a folder in `samples` and add a `package.json` and a `tsconfig.json`:
3+
A sample should have the same name as the service but it may include a short description in the name after the service name aswell.
4+
E.g. `twitch-chat` or `obs-scenelist`.
5+
6+
Create a folder in `samples` named after the sample and add a `package.json` and a `tsconfig.json`:
47

58
```json
69
{

0 commit comments

Comments
 (0)