contribute-now 0.10.0 → 0.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -10
- package/dist/cli.js +394 -315
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -38,17 +38,19 @@ contribute-now validates commit messages and guides your AI toward the right for
|
|
|
38
38
|
## Quick Start
|
|
39
39
|
|
|
40
40
|
```bash
|
|
41
|
+
npx contribute-now setup
|
|
42
|
+
# or
|
|
41
43
|
bunx contribute-now setup
|
|
42
44
|
```
|
|
43
45
|
|
|
44
46
|
Or install globally:
|
|
45
47
|
|
|
46
48
|
```bash
|
|
47
|
-
|
|
49
|
+
npm install -g contribute-now
|
|
48
50
|
contribute setup
|
|
49
51
|
```
|
|
50
52
|
|
|
51
|
-
`contribute-now`
|
|
53
|
+
`contribute-now` runs on Node.js at runtime. Node.js 26 is the default target, with Node.js 22 and 24 LTS also supported. Bun remains the toolchain for local development, builds, tests, and `bunx` workflows.
|
|
52
54
|
|
|
53
55
|
> `contribute` is the primary command; `cn` is the short alias for the same binary — use whichever you prefer.
|
|
54
56
|
>
|
|
@@ -61,18 +63,20 @@ contribute setup
|
|
|
61
63
|
## Installation
|
|
62
64
|
|
|
63
65
|
```bash
|
|
64
|
-
# one-off
|
|
66
|
+
# one-off under Node.js
|
|
67
|
+
npx contribute-now setup
|
|
68
|
+
|
|
69
|
+
# one-off with Bun toolchain
|
|
65
70
|
bunx contribute-now setup
|
|
66
71
|
|
|
67
72
|
# global
|
|
68
|
-
|
|
73
|
+
npm install -g contribute-now
|
|
69
74
|
```
|
|
70
75
|
|
|
71
|
-
If you prefer
|
|
76
|
+
If you prefer Bun for installation, the packaged CLI still runs on Node.js after install:
|
|
72
77
|
|
|
73
78
|
```bash
|
|
74
|
-
|
|
75
|
-
npm install -g contribute-now
|
|
79
|
+
bun install -g contribute-now
|
|
76
80
|
```
|
|
77
81
|
|
|
78
82
|
Once installed, you can use either alias:
|
|
@@ -86,6 +90,7 @@ cn setup # short alias — even shorter than git!
|
|
|
86
90
|
|
|
87
91
|
## Prerequisites
|
|
88
92
|
|
|
93
|
+
- **[Node.js](https://nodejs.org/)** — runtime target is Node.js 26 by default; Node.js 22 and 24 LTS are also supported
|
|
89
94
|
- **[Git](https://git-scm.com/)** — required
|
|
90
95
|
- **[GitHub CLI](https://cli.github.com)** (`gh`) — recommended; required for PR creation, role detection, and merge status checks
|
|
91
96
|
- **[GitHub Copilot](https://github.com/features/copilot)** — optional; one of the supported AI providers
|
|
@@ -239,7 +244,7 @@ cn doctor --json # machine-readable JSON output
|
|
|
239
244
|
```
|
|
240
245
|
|
|
241
246
|
Checks include:
|
|
242
|
-
- CLI version and runtime
|
|
247
|
+
- CLI version, active runtime, and Node.js runtime policy
|
|
243
248
|
- git and GitHub CLI availability and authentication
|
|
244
249
|
- active repo config validity and storage location
|
|
245
250
|
- Git repo state (uncommitted changes, lock files, shallow clone)
|
|
@@ -472,12 +477,12 @@ git clone https://github.com/warengonzaga/contribute-now.git
|
|
|
472
477
|
cd contribute-now
|
|
473
478
|
bun install
|
|
474
479
|
|
|
475
|
-
bun run build # compile to dist/
|
|
480
|
+
bun run build # compile to dist/cli.js
|
|
476
481
|
bun test # run tests
|
|
477
482
|
bun run lint # check code quality
|
|
478
483
|
```
|
|
479
484
|
|
|
480
|
-
|
|
485
|
+
Bun powers local development, build, and test workflows. The packaged CLI runs on Node.js 22, 24, or 26, with Node.js 26 as the default runtime target.
|
|
481
486
|
|
|
482
487
|
## 🎯 Contributing
|
|
483
488
|
|