Skip to content

docs: OSS community docs — Code of Conduct, Contributing, Changelog - #3

Merged
prdai merged 1 commit into
mainfrom
chore/oss-ready
Jun 20, 2026
Merged

docs: OSS community docs — Code of Conduct, Contributing, Changelog#3
prdai merged 1 commit into
mainfrom
chore/oss-ready

Conversation

@prdai

@prdai prdai commented Jun 20, 2026

Copy link
Copy Markdown
Member

Makes the project OSS-ready with standard community health files.

Added

  • CODE_OF_CONDUCT.md — Contributor Covenant 2.1. Community leaders: BitByBit (B3) / prdai. Enforcement contacts: bitbybit0123@gmail.com (org) and go2ranuga@gmail.com (lead maintainer).
  • CONTRIBUTING.md — adapted from the requested reference to our setup: fork from main, Bun package manager, Biome + Lefthook + tests, full dev workflow and git-hook behavior documented.
  • CHANGELOG.mdKeep a Changelog format + SemVer, with the initial [Unreleased] feature set.
  • README — Contributing section linking the above.

Notes

  • Base/PR branch standardized on main (no dev branch).
  • Markdown only — no code changes; CI should be green.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added Code of Conduct establishing community standards and behavioral expectations.
    • Added comprehensive Contributing guidelines with development setup, testing, and submission procedures.
    • Updated README with links to contribution resources.
    • Added Changelog with detailed documentation of project updates and features.

- CODE_OF_CONDUCT.md: Contributor Covenant 2.1, BitByBit (B3) / prdai as
  community leaders, enforcement contacts.
- CONTRIBUTING.md: adapted to our setup — fork from main, bun + Biome +
  Lefthook + tests, dev workflow and hook behavior.
- CHANGELOG.md: Keep a Changelog format with the initial Unreleased set.
- README: add Contributing section linking the above.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Review Change Stack

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Free

Run ID: 507620f6-bc0b-4b28-846f-0b87e113bc09

📥 Commits

Reviewing files that changed from the base of the PR and between 63fe5a0 and c73546a.

📒 Files selected for processing (4)
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • README.md

Walkthrough

Adds three new community documentation files (CHANGELOG.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md) and inserts a Contributing section into README.md. The changelog documents Cloudflare KV cache adapter features under [Unreleased]. The code of conduct uses Contributor Covenant v2.1. The contributing guide covers workflows, dev setup, tooling, and style rules.

Changes

Community & Contribution Docs

Layer / File(s) Summary
CHANGELOG and Code of Conduct
CHANGELOG.md, CODE_OF_CONDUCT.md
CHANGELOG.md is initialized with a Keep a Changelog [Unreleased] section listing all Cloudflare KV cache adapter features. CODE_OF_CONDUCT.md adds the full Contributor Covenant v2.1 text including community standards, enforcement tiers, and reporting contacts.
CONTRIBUTING guide and README link
CONTRIBUTING.md, README.md
CONTRIBUTING.md is fully written with bug/PR workflows, Bun dev commands, Lefthook git hook docs, Biome style rules, and changelog update instructions. README.md gets a new Contributing section that links directly to all three new files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

📜 A changelog was born, a covenant signed,
Contributing rules now clearly defined.
Bun runs the tests, Biome keeps it clean,
Lefthook stands guard — the strictest routine.
README says "Welcome!" with links to the rest.
Community docs: the unsung project best. 🎉


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
drizzle-kv-cache-docs c73546a Jun 20 2026, 06:01 PM

@prdai
prdai merged commit 5609c42 into main Jun 20, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant