Skip to content

fix(lib): Update README and CLI for improved clarity#21

Merged
JFusco merged 1 commit intomainfrom
feat/det-install
Apr 2, 2026
Merged

fix(lib): Update README and CLI for improved clarity#21
JFusco merged 1 commit intomainfrom
feat/det-install

Conversation

@JFusco
Copy link
Copy Markdown
Collaborator

@JFusco JFusco commented Apr 2, 2026

fix(lib): Update README and CLI for improved clarity

Summary (AI, bounded)

  • Update README.md and CLI scripts for improved clarity and usability, including additions to lib/core/git.js, lib/init-env.js, lib/init-paths.js, and lib/init-workspace.js as reflected in commit 48ab180.

Changes

  • 48ab180 fix(lib): Update README and CLI for improved clarity

Files changed

  • M README.md
  • M bin/cli.js
  • M lib/core/git.js
  • M lib/init-env.js
  • A lib/init-paths.js
  • M lib/init-workspace.js

Diff stats

README.md             | 29 ++++++++++++--------
 bin/cli.js            | 76 ++++++++++++++++++++++++++++++++++++++-------------
 lib/core/git.js       | 50 +++++++++++++++++++++++++++++++++
 lib/init-env.js       | 15 +++++++---
 lib/init-paths.js     | 65 +++++++++++++++++++++++++++++++++++++++++++
 lib/init-workspace.js | 13 +++++++--
 6 files changed, 211 insertions(+), 37 deletions(-)

Testing

  • Manual smoke test
  • CI green

Risk / Impact

  • Risk level: Low / Medium / High
  • Rollback plan:

Base: main → Head: feat/det-install

Suggested labels / Review checklist

Suggested labels: docs, cli, lib, enhancement

Review checklist:

  • Verify README updates improve clarity and accuracy
  • Test CLI functionality for regressions or usability improvements
  • Confirm new or modified library code behaves as expected
  • Ensure all changes pass CI checks and manual smoke tests

@JFusco
fix(lib): Update README and CLI for improved clarity
48ab180 
The README and CLI documentation have been revised to enhance clarity
regarding the setup process. The instructions now specify that the setup
should be performed from the app directory where `@verndale/ai-commit`
is installed, rather than the git repository root. This change aims to
prevent confusion, especially in monorepo setups.

Additionally, the CLI command descriptions have been updated to better
reflect the behavior of the `init` command and its flags. These
improvements will help users understand the expected outcomes and the
structure of the environment files more clearly.

No issue references detected.
@JFusco JFusco marked this pull request as ready for review April 2, 2026 12:14
@JFusco JFusco merged commit 3b197e8 into main Apr 2, 2026
3 checks passed
@JFusco JFusco deleted the feat/det-install branch April 2, 2026 12:15
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

🎉 This PR is included in version 2.5.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JFusco