You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 13, 2025. It is now read-only.
_Note 1:_ This path should point to the root of this repository, not to a bundle inside this repo.
51
-
52
-
_Note 2:_ The second path to the samples is only required if you want to use a sample plugin.
53
-
54
-
_Note 3:_ If nodecg doesn't load nodecg-io for some reason you might want to use an absolute path here.
45
+
_Note:_ Watching all packages requires a lot of RAM.
46
+
Instead you can watch just the packages you are actively working on e.g. `npm run watch -- --scope nodecg-io-twitch-chat --scope twitch-chat`.
47
+
This will just spawn a watch process for the twitch-chat sample and service and require way less memory.
55
48
56
49
## Run
57
50
58
51
To test the changes you simply need to start/restart nodecg.
59
52
60
-
### Automated Testing
61
-
62
-
> Nothing yet
63
-
64
-
### Unit Testing
53
+
## Adding dependencies to packages
65
54
66
-
> Nothing yet
55
+
This project uses [lerna](https://lerna.js.org) to manage our monorepo and most importantly link all our packages together.
56
+
Because of linking you should not use `npm install xyz --save` to add dependencies because npm can't get the development version of internal packages like `nodecg-io-core`. Doing so will result in an error and break the link.
57
+
Instead you should edit the `package.json` directly using a text editor and the run `npm run bootstrap` in the repository root.
67
58
68
-
## Work Branches
59
+
## Open a Pull Request
69
60
70
-
Even if you have push rights on the codeoverflow-org/nodecg-io repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your personal workflow cruft out of sight.
61
+
Once you have implemented your feature or fixed a bug push it to your fork and start a Pull Request.
71
62
72
-
## Pull Requests
63
+
## Merge Upstream Changes
73
64
74
65
Occasionally you will want to merge changes in the upstream repository (the official code repo) with your fork.
Manage any merge conflicts, commit them, and then push them to your fork. Now you can make a pull request from your folk.
73
+
Manage any merge conflicts, commit them, and then push them to your fork.
74
+
75
+
You may also occasionally need to merge upstream master in a pull request. To do that make the above to update your local master and the merge your local master into your PR branch.
83
76
84
77
### Where to Contribute
85
78
86
79
After cloning and building the repo, check out the [issues list](https://github.com/codeoverflow-org/nodecg-io/issues). Issues labeled [`help wanted`](https://github.com/codeoverflow-org/nodecg-io/labels/help%20wanted) are good issues to submit a PR for. Issues labeled [`good first issue`](https://github.com/codeoverflow-org/nodecg-io/labels/good%20first%20issue) are great candidates to pick up if you are in the code for the first time. If you are contributing significant changes, please discuss with the assignee of the issue first before starting to work on the issue.
87
80
88
-
## Packaging
89
-
90
-
> Maybe in the future
91
-
92
81
## Suggestions
93
82
94
83
We're also interested in your feedback. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.
Copy file name to clipboardExpand all lines: docs/contribute/sample_documentation.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,4 +4,4 @@ To document a sample bundle take a look at the name of the service the sample bu
4
4
5
5
Don't forget to add the newly created MarkDown file to `mkdocs.yml`. When you create your documentation pull request, please include the id of your PR in the main repository in the description so the documentation is not merged before the actual code.
6
6
7
-
You should make this very detailed so everyone gets it to work because a super-good implementation is worth nothing if there's nobody who can use it. Take a look at the [twitch sample bundle](../samples/twitch.md).
7
+
You should make this very detailed so everyone gets it to work because a super-good implementation is worth nothing if there's nobody who can use it. Take a look at the [twitch sample bundle](../samples/twitch-chat.md).
0 commit comments