chore(oss): polish for OSS distribution (FUNDING + CONTRIBUTING + README)#13
chore(oss): polish for OSS distribution (FUNDING + CONTRIBUTING + README)#13Cramraika wants to merge 1 commit into
Conversation
…DME) P2a of the framework-wiring/OSS-sponsorship workstream (vagary-platform/docs/plans/2026-04-19-framework-wiring-and-oss-sponsorship-plan.md). Prep this repo for ongoing OSS positioning now that the engine has been absorbed upstream into vagary-platform/backend/framework/notifications/fanout/. Changes: - .github/FUNDING.yml: add verified Buy Me a Coffee handle (vagarylife, https://buymeacoffee.com/vagarylife). github_sponsors line unchanged. Polar/Ko-fi remain commented (no accounts yet). - CONTRIBUTING.md (new): development setup, PR workflow, code style, security disclosure pointer, MIT license note, sponsorship CTA, and an explicit upstream-relationship section pointing to vagary-platform's fanout package so contributors know where engine-level changes can also land. - README.md: * Title: "Enhanced Bulk API Trigger Platform v2.0" → "bulk — webhook/API trigger platform" (matches new repo name post-rename 2026-04-19) * Badges: stars + license badges now point to Cramraika/bulk (was Cramraika/bulk_api_trigger); add Buy Me a Coffee badge * Sponsor section: list GH Sponsors + BMC + personal site * New "Upstream / where this engine lives" section explaining the bulk-vs-vagary-platform-fanout relationship and when to use each * Quick Start: real clone URL (was <your-repo-url>), folder name `bulk`, container name `bulk`, .env.example (was .env.sample) * Add MIT License footer pointing at LICENSE * Contributing section now defers to CONTRIBUTING.md and SECURITY.md - Added rename heads-up note for users with old `bulk_api_trigger` remotes. Verification: - History secret-scan clean — three historical .env commits (74b95f8, 53077ab, eedad94) all contained placeholder/template values only (your_email@gmail.com, your_app_password, etc.). No real secrets leaked. .env is not in current HEAD; .env.example serves as the template. - All grep hits in current tree are placeholder strings, env-var lookups, or redaction code paths — no real secret material. DO NOT MERGE until the manual public-flip gate (P2c) is confirmed. Co-Authored-By: Claude <noreply@anthropic.com>
📝 WalkthroughWalkthroughThis PR updates project documentation and configuration to reflect a repository rebrand from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 293-300: The Kubernetes manifest in the README renames resources
to "bulk" but leaves secretRef.name as "bulk-api-secrets", causing a naming
mismatch; update the secret reference to match the new naming convention (e.g.,
change secretRef.name from "bulk-api-secrets" to "bulk" or another consistent
name) and ensure any other mentions (the second occurrence around line 309) are
updated as well so the Deployment/container name "bulk" and the secret reference
are aligned.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 2e2a3d12-b411-4ec2-8a85-2d9e8a616f0b
📒 Files selected for processing (3)
.github/FUNDING.ymlCONTRIBUTING.mdREADME.md
| name: bulk | ||
| spec: | ||
| replicas: 1 | ||
| template: | ||
| spec: | ||
| containers: | ||
| - name: bulk-api-trigger | ||
| image: your-registry/bulk-api-trigger:latest | ||
| - name: bulk | ||
| image: your-registry/bulk:latest |
There was a problem hiding this comment.
Potential stale secret name after rebrand.
Kubernetes example renames resources to bulk, but secretRef.name is still bulk-api-secrets. Consider aligning it to the new naming convention to avoid setup confusion.
Also applies to: 309-309
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 293 - 300, The Kubernetes manifest in the README
renames resources to "bulk" but leaves secretRef.name as "bulk-api-secrets",
causing a naming mismatch; update the secret reference to match the new naming
convention (e.g., change secretRef.name from "bulk-api-secrets" to "bulk" or
another consistent name) and ensure any other mentions (the second occurrence
around line 309) are updated as well so the Deployment/container name "bulk" and
the secret reference are aligned.
Summary
P2a of the framework-wiring/OSS-sponsorship plan. Polishes this repo for ongoing OSS positioning now that the engine has also been absorbed upstream into vagary-platform/backend/framework/notifications/fanout/.
History secret-scan ✅
Scanned all branches for committed secrets:
This PR is part of P2 of the larger plan and is gated by the manual public-flip gate (P2c) on the upstream plan. Hold for explicit user confirmation before merging.
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores