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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,14 @@
1
-
# Contributing to CapiscIO CLI
1
+
# Contributing to CapiscIO CLI (Node.js Wrapper)
2
2
3
-
Thank you for your interest in contributing to CapiscIO CLI! This document provides guidelines and information for contributors.
3
+
Thank you for your interest in contributing to the CapiscIO CLI wrapper! This repository is `capiscio-node`, and the published npm package name is `capiscio`.
4
+
5
+
!!! note "Where the binaries come from"
6
+
This project downloads the `capiscio-core` GitHub Release binaries at runtime. Core binaries are published from https://github.com/capiscio/capiscio-core.
4
7
5
8
## 🚀 Quick Start
6
9
7
10
1. Fork the repository
8
-
2. Clone your fork: `git clone https://github.com/your-username/capiscio-cli.git`
11
+
2. Clone your fork: `git clone https://github.com/your-username/capiscio-node.git`
9
12
3. Install dependencies: `npm install`
10
13
4. Create a feature branch: `git checkout -b feature/your-feature-name`
11
14
5. Make your changes
@@ -43,7 +46,7 @@ git push origin main
43
46
44
47
#### 2. Create Draft Release
45
48
46
-
1. Go to [GitHub Releases](https://github.com/capiscio/capiscio-cli/releases)
49
+
1. Go to [GitHub Releases](https://github.com/capiscio/capiscio-node/releases)
47
50
2. Click "Create a new release"
48
51
3.**Important**: Create as **Draft** (do not publish yet)
49
52
4. Set tag version (e.g., `v1.2.3`)
@@ -54,7 +57,7 @@ git push origin main
54
57
#### 3. Wait for Binary Upload
55
58
56
59
1. The **Build and Release Binaries** workflow will trigger automatically
57
-
2. Monitor the [Actions tab](https://github.com/capiscio/capiscio-cli/actions)
60
+
2. Monitor the [Actions tab](https://github.com/capiscio/capiscio-node/actions)
58
61
3. Wait for all binaries to be built and uploaded (~10-15 minutes)
0 commit comments