contribute-now 0.6.2-dev.d6e92ac → 0.6.2-staging.560304f

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.
Files changed (3) hide show
  1. package/README.md +24 -9
  2. package/dist/index.js +2775 -424
  3. package/package.json +3 -1
package/README.md CHANGED
@@ -83,7 +83,7 @@ cn setup # shortest — even shorter than git!
83
83
 
84
84
  ### `contrib setup`
85
85
 
86
- Interactive setup wizard. Configures your repo's workflow mode, commit convention, your role, and branch/remote names. Writes `.contributerc.json`.
86
+ Interactive setup wizard. Configures your repo's workflow mode, commit convention, your role, branch/remote names, and AI provider settings. Writes local config to `.git/contribute-now/config.json` by default.
87
87
 
88
88
  ```bash
89
89
  contrib setup
@@ -93,13 +93,28 @@ Steps:
93
93
  1. Choose **workflow mode** — Clean Flow, GitHub Flow, or Git Flow
94
94
  2. Choose **commit convention** — Clean Commit, Conventional Commits, or None
95
95
  3. Choose whether **AI features** should be enabled for this repo
96
- 4. Detect remotes and auto-detect your **role** (maintainer or contributor)
97
- 5. Confirm branch and remote names
98
- 6. Write `.contributerc.json`
96
+ 4. If using **Ollama Cloud**, pick from the available models returned by your API key, or enter one manually
97
+ 5. Detect remotes and auto-detect your **role** (maintainer or contributor)
98
+ 6. Confirm branch and remote names
99
+ 7. Write `.git/contribute-now/config.json` (or update `.contributerc.json` if that legacy file is still the active source)
99
100
 
100
- If you want to disable AI completely for a repo, run `contrib setup` and turn AI off, or set `"aiEnabled": false` in `.contributerc.json`. Per-command `--no-ai` flags still work as one-off overrides when AI is enabled globally.
101
+ If you want to disable AI completely for a repo, run `contrib setup` and turn AI off, or set `"aiEnabled": false` in the active config file. Per-command `--no-ai` flags still work as one-off overrides when AI is enabled globally.
101
102
 
102
- If you want a cleaner output once you're familiar with the CLI, set `"showTips": false` in `.contributerc.json` to hide the beginner quick guides and loading tips.
103
+ If you want a cleaner output once you're familiar with the CLI, set `"showTips": false` in the active config file to hide the beginner quick guides and loading tips.
104
+
105
+ ---
106
+
107
+ ### `contrib config`
108
+
109
+ Inspect the active repo config or edit it without rerunning the full setup flow.
110
+
111
+ ```bash
112
+ contrib config
113
+ contrib config --json
114
+ contrib config --edit
115
+ ```
116
+
117
+ Use `--edit` to update workflow settings, branch names, commit convention, AI provider details, the stored Ollama Cloud API key, and to choose from the currently available Ollama Cloud models. Ollama Cloud uses the built-in default host and does not ask for a custom host URL.
103
118
 
104
119
  ---
105
120
 
@@ -212,7 +227,7 @@ contrib doctor --json # machine-readable JSON output
212
227
  Checks include:
213
228
  - CLI version and runtime (Bun/Node)
214
229
  - git and GitHub CLI availability and authentication
215
- - `.contributerc.json` validity and `.gitignore` status
230
+ - active repo config validity and storage location
216
231
  - Git repo state (uncommitted changes, lock files, shallow clone)
217
232
  - Fork and remote configuration
218
233
  - Workflow and branch setup
@@ -340,7 +355,7 @@ feat!: redesign authentication API
340
355
 
341
356
  ## Config File
342
357
 
343
- `contrib setup` writes `.contributerc.json` to your repo root:
358
+ `contrib setup` writes `.git/contribute-now/config.json` by default. If a legacy `.contributerc.json` already exists, it remains the active source until you migrate or remove it:
344
359
 
345
360
  ```json
346
361
  {
@@ -355,7 +370,7 @@ feat!: redesign authentication API
355
370
  }
356
371
  ```
357
372
 
358
- > Add `.contributerc.json` to your `.gitignore` it contains personal config and should not be committed.
373
+ Use `contrib config --edit` to change these values later without rerunning the full setup flow. If you are still on the legacy `.contributerc.json`, keep that file ignored until you migrate away from it.
359
374
 
360
375
  ---
361
376