Skip to content

update README#2267

Merged
jcubic merged 1 commit intomainfrom
update-readme
Dec 14, 2025
Merged

update README#2267
jcubic merged 1 commit intomainfrom
update-readme

Conversation

@jcubic
Copy link
Member

@jcubic jcubic commented Dec 14, 2025

I'm fixing a bug or typo

  • if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README
  • squash merge the PR with commit message "fix: [Description of fix]"

I'm adding a parameter to an existing command X:

  • add parameter to the function in src/api/X.js (and src/commands/X.js if necessary)
  • document the parameter in the JSDoc comment above the function
  • add a test case in __tests__/test-X.js if possible
  • if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README

I'm adding a new command:

  • add as a new file in src/api (and src/commands if necessary)
  • add command to src/index.js
  • update __tests__/test-exports.js
  • create a test in src/__tests__
  • document the command with a JSDoc comment
  • add page to the Docs Sidebar website/sidebars.json
  • add page to the v1 Docs Sidebar website/versioned_sidebars/version-1.x-sidebars.json
  • if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README
  • squash merge the PR with commit message "feat: Added 'X' command"

Summary by CodeRabbit

  • Documentation
    • Updated README.md to document the automated release process using semantic-release. Added information about how releases are now handled automatically following PR merges.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 14, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation updates to README.md adding information about automated releases via semantic-release. Two content blocks are inserted to inform users that releases are now automatically generated after PR merges, with references and links to the semantic-release tool.

Changes

Cohort / File(s) Change Summary
Documentation Updates
README.md
Added two documentation blocks describing automated release process using semantic-release; inserted after npm install/test snippet and near Contributing section

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Pure documentation changes with no code logic or functional impact
  • Straightforward text additions to inform users about release automation

Poem

🐰 The releases now flow with semantic grace,
No manual merges to chase and retrace,
Automation's sweet dance, a changelog's delight,
From PR to release—it's done overnight!
The README now speaks of this magical spree,

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-readme

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd54d92 and 623836a.

📒 Files selected for processing (1)
  • README.md (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jcubic jcubic merged commit 93d3ef9 into main Dec 14, 2025
2 of 6 checks passed
@jcubic jcubic deleted the update-readme branch December 14, 2025 08:22
@isomorphic-git-bot
Copy link
Member

🎉 This PR is included in version 1.36.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@coderabbitai coderabbitai bot mentioned this pull request Jan 20, 2026
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments