chore: prepare repo for open source - #52
Merged
Merged
Conversation
- Add MIT LICENSE file - Rewrite README to accurately describe CommitStory - Replace hardcoded KV namespace ID in wrangler.toml with placeholder - Add CONTRIBUTING.md with setup and contribution guidelines Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
The KV namespace ID is a resource identifier, not a secret. Contributors will create their own namespace for local development. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe PR replaces the README with CommitStory product and development documentation, adds end-to-end contribution guidance, and introduces an MIT license file. ChangesRepository Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 93: Update the fenced Conventional Commits example in CONTRIBUTING.md by
adding the text language tag to its opening fence, preserving the example
content and closing fence.
In `@README.md`:
- Line 73: Update the repository tree code fence in README.md to include a
language tag, preferably text, immediately after the opening fence while
preserving the enclosed content.
- Around line 117-122: Update the README secret setup commands to invoke the
locally installed Wrangler consistently by prefixing both `secret put` commands
with `npx`, matching the surrounding setup instructions and avoiding reliance on
a global installation.
- Around line 44-48: Update the README environment setup instructions near the
.dev.vars copy command to match CONTRIBUTING.md by including the required .env
copy step, or explicitly document why .env is needed if the flows intentionally
differ.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: d32c38fc-b466-41d0-b23c-becbc7668599
📒 Files selected for processing (3)
CONTRIBUTING.mdLICENSEREADME.md
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
commitstory | 6e21690 | Commit Preview URL Branch Preview URL |
Jul 16 2026, 10:19 AM |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Owner
Author
Fixes Applied SuccessfullyFixed 2 file(s) based on 4 unresolved review comment(s). Files modified:
Commit: The latest autofix changes are on the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The repo is going open source but was missing standard OSS files and the README described a completely different project (an Nx demo with
shop/apiapps).What changed
LICENSE-- MIT license file to match the"license": "MIT"already declared inpackage.json.README.md-- Replaced the auto-generated Nx template README with an accurate description of CommitStory: what it does, the tech stack (Angular 21 + Cloudflare Workers + Gemini AI), setup instructions, project structure, and development/deployment commands.CONTRIBUTING.md-- Covers prerequisites, local setup (including creating your own KV/R2 resources), dev workflow via Nx, PR guidelines, and issue reporting.Summary by CodeRabbit