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

Commit 8601660

Browse files
authored
Merge pull request #41 from codeoverflow-org/sample-naming-convention
Document sample naming convention
2 parents bce0e66 + 0246564 commit 8601660

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/contribute/contribute.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ First you'll need a installation of nodecg-io. Please refer to the [installation
66
instead of using our repository you might want to fork the nodecg-io repository to your GitHub account and clone your fork.
77

88
To make changes to the documentation you also need to clone the docs repo:
9+
910
```shell
1011
git clone https://github.com/codeoverflow-org/nodecg-io-docs.git
1112
```

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)