contribute-now 0.7.1 → 0.7.2-dev.bca36bd
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 +17 -6
- package/dist/cli.js +17339 -0
- package/dist/index.js +31 -17343
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -37,16 +37,18 @@ contribute-now validates commit messages and guides your AI toward the right for
|
|
|
37
37
|
## Quick Start
|
|
38
38
|
|
|
39
39
|
```bash
|
|
40
|
-
|
|
40
|
+
bunx contribute-now setup
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
Or install globally:
|
|
44
44
|
|
|
45
45
|
```bash
|
|
46
|
-
|
|
46
|
+
bun install -g contribute-now
|
|
47
47
|
contrib setup
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
+
`contribute-now` now runs on Bun at runtime. Use `bunx` for one-off execution and `bun install -g` for a global install.
|
|
51
|
+
|
|
50
52
|
> `contrib`, `contribute`, and `cn` all invoke the same binary — use whichever you prefer.
|
|
51
53
|
>
|
|
52
54
|
> **Fun fact:** `cn` is shorter than `git`. Yes, your workflow command is now faster to type than git itself. 🚀
|
|
@@ -56,13 +58,20 @@ contrib setup
|
|
|
56
58
|
## Installation
|
|
57
59
|
|
|
58
60
|
```bash
|
|
59
|
-
#
|
|
60
|
-
|
|
61
|
+
# one-off
|
|
62
|
+
bunx contribute-now setup
|
|
61
63
|
|
|
62
|
-
#
|
|
64
|
+
# global
|
|
63
65
|
bun install -g contribute-now
|
|
64
66
|
```
|
|
65
67
|
|
|
68
|
+
If you prefer to install the package from npm, install Bun first and then install `contribute-now`:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
npm install -g bun
|
|
72
|
+
npm install -g contribute-now
|
|
73
|
+
```
|
|
74
|
+
|
|
66
75
|
Once installed, you can use any of the three aliases:
|
|
67
76
|
|
|
68
77
|
```bash
|
|
@@ -225,7 +234,7 @@ contrib doctor --json # machine-readable JSON output
|
|
|
225
234
|
```
|
|
226
235
|
|
|
227
236
|
Checks include:
|
|
228
|
-
- CLI version and runtime (Bun
|
|
237
|
+
- CLI version and runtime (Bun)
|
|
229
238
|
- git and GitHub CLI availability and authentication
|
|
230
239
|
- active repo config validity and storage location
|
|
231
240
|
- Git repo state (uncommitted changes, lock files, shallow clone)
|
|
@@ -386,6 +395,8 @@ bun test # run tests
|
|
|
386
395
|
bun run lint # check code quality
|
|
387
396
|
```
|
|
388
397
|
|
|
398
|
+
The CLI is Bun-first end to end: local development, tests, packaged runtime, and one-off execution all assume Bun.
|
|
399
|
+
|
|
389
400
|
## 🎯 Contributing
|
|
390
401
|
|
|
391
402
|
Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the `dev` branch. Thank you!
|