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

Commit 814d2dd

Browse files
committed
Update contribution guide for cli dev installs
1 parent 12ea639 commit 814d2dd

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/contribute/contribute.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22

33
There are many ways to contribute to nodecg-io: logging bugs, submitting pull requests, reporting issues, and creating suggestions.
44

5-
First you'll need an installation of nodecg-io. Please refer to the [installation guide](../getting_started/install.md) but
6-
instead of using our repository you might want to fork the nodecg-io repository to your GitHub account and clone your fork.
7-
8-
To make changes to the documentation you also need to clone the docs repo:
9-
5+
First you'll need an installation of nodecg-io. Please refer to the [installation guide](../getting_started/install.md) and create a development installation.
6+
The cli asks you whether you want to clone the documentation. It's highly recommended that you do that and update the documentation as you add new services or features.
7+
To be able to create Pull Requests you should fork the corresponding repositories and add them as a remote (update url for e.g. documentation repository):
108
```shell
11-
git clone https://github.com/codeoverflow-org/nodecg-io-docs.git
9+
git remote add fork https://github.com/[YOUR_USERNAME]/nodecg-io.git
10+
```
11+
12+
Then you can create a new branch, do your changes, create commits and publish the branch to your fork using the following command:
13+
```
14+
git push fork my-branch
1215
```
1316

1417
## Build

0 commit comments

Comments
 (0)