Skip to content

chore: add CI, contributor templates, and launch polish - #3

Merged
AhmedFr merged 1 commit into
mainfrom
chore/ci-and-contributor-templates
Jun 18, 2026
Merged

AhmedFr merged 1 commit into
mainfrom
chore/ci-and-contributor-templates

Conversation

@AhmedFr

@AhmedFr AhmedFr commented Jun 18, 2026 •

Copy link
Copy Markdown
Owner

What & why

Adds the CI/CD and contributor fundamentals we were missing before launch, plus
two bits of launch polish.

  • CI — .github/workflows/ci.yml runs typecheck → lint → test → build on
    push to main and every PR (pnpm 11 / Node 20, --frozen-lockfile,
    cancel-in-progress concurrency). README gets a matching CI status badge.
  • Contributor templates — PR template + bug/feature issue forms + config that
    nudges contributors to the forms.
  • Self-enforcement — project CLAUDE.md binds PR/issue authoring to those
    templates and to passing all four gates before opening a PR.
  • NEXT_PUBLIC_SITE_URL documented in .env.example so Open Graph / Twitter
    card images resolve on a real deploy instead of localhost.
  • 50-star reward set to a free hosted version (landing page + README), replacing
    the [your reward here] placeholder.

How it was tested

  • pnpm test — 71 passed
  • pnpm typecheck
  • pnpm lint
  • pnpm build

YAML for the workflow and issue forms was also validated with a parser.

Checklist

  • Follows the single-responsibility / per-component folder structure
  • No secrets, API keys, or .env values committed
  • README / docs updated if behavior or configuration changed
  • Screenshots included for UI changes — n/a (only a one-line copy change to the landing milestone text)

Screenshots / notes

Follow-ups for the maintainer:

  • Enable Discussions in repo settings, or the contact link in
    .github/ISSUE_TEMPLATE/config.yml should point at issues instead.
  • CD is intentionally deferred until a hosting target exists (that's the reward).

Summary by CodeRabbit

  • New Features

    • Added configuration for improved Open Graph and social media card previews when content is shared.
  • Documentation

    • Updated star milestone messaging: reaching 50 stars unlocks a free hosted version.
  • Chores

    • Implemented automated CI/CD pipeline.
    • Added structured issue and pull request templates.
    • Added project contribution guidelines.

- ci: add GitHub Actions workflow (pnpm 11 / Node 20) gating
  typecheck → lint → test → build on push to main and every PR
- github: add PR template + bug/feature issue forms + config
- docs: add project CLAUDE.md binding PR/issue authoring to the templates
- env: document NEXT_PUBLIC_SITE_URL so OG/Twitter cards resolve on deploy
- reward: set 50-star milestone to a free hosted version (landing + README)
- readme: add CI status badge

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@AhmedFr
AhmedFr merged commit b45d71c into main Jun 18, 2026
0 of 2 checks passed
@coderabbitai

coderabbitai Bot commented Jun 18, 2026 •

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: f1fefd6a-7362-4d67-89a8-e539d449917d

📥 Commits

Reviewing files that changed from the base of the PR and between dbd9050 and d4d9567.

📒 Files selected for processing (9)
  • .env.example
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/pull_request_template.md
  • .github/workflows/ci.yml
  • CLAUDE.md
  • README.md
  • app/page.tsx

📝 Walkthrough

Walkthrough

Adds GitHub contributor infrastructure: a CI Actions workflow (typecheck, lint, test, build with pnpm), structured bug and feature request issue form templates, a populated PR template, a CLAUDE.md contributor guide, and a CI badge in the README. Also replaces the star-milestone reward placeholder with a concrete free-hosted-version promise in both README and the landing page, and adds NEXT_PUBLIC_SITE_URL to .env.example.

Changes

GitHub Contributor Infrastructure

Layer / File(s) Summary
CI workflow
.github/workflows/ci.yml
Defines a CI workflow triggered on push to main and all PRs, with concurrency cancellation; the verify job installs dependencies via frozen lockfile then runs typecheck, lint, test, and build in sequence.
Issue templates, PR template, and contributor guidance
.github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/config.yml, .github/ISSUE_TEMPLATE/feature_request.yml, .github/pull_request_template.md, CLAUDE.md
Adds structured bug and feature request issue forms with required fields and dropdowns; disables blank issues and routes questions to Discussions; populates the PR template with description, test, and checklist sections; adds CLAUDE.md mandating template use and the four pre-PR pnpm commands.

Star Milestone Messaging and Env Config

Layer / File(s) Summary
Star milestone text and env var
README.md, app/page.tsx, .env.example
Replaces [your reward here] placeholder with a specific free hosted browser version promise in both README and landing page CTA; adds CI status badge to README; adds NEXT_PUBLIC_SITE_URL (blank for local) for absolute OG/Twitter card URLs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐇 Hop hop, the templates are set,
No blank issues to fret!
CI runs with a zip,
Lint and build, what a trip.
Fifty stars brings a treat — 🌟
A free hosted seat!
The warren is tidy and neat. ✨

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/ci-and-contributor-templates

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.

@AhmedFr
AhmedFr deleted the chore/ci-and-contributor-templates branch June 18, 2026 08:58
@AhmedFr AhmedFr mentioned this pull request Jun 18, 2026
7 of 9 tasks
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