Skip to content

Add example standards, template and CI format checks - #11

Merged
dazzatronus merged 1 commit into
masterfrom
example-standards
Aug 6, 2026
Merged

Add example standards, template and CI format checks#11
dazzatronus merged 1 commit into
masterfrom
example-standards

Conversation

@dazzatronus

@dazzatronus dazzatronus commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Nothing enforced the repo's own .prettierrc, and the four examples had drifted apart on naming, declared Node floors and format scripts. This adds the enforcement and writes the conventions down.

What changed

  • STANDARDS.md — credential handling, failure behaviour, README shape, runtime-version rules, and what to check before opening a pull request.
  • examples/_template/ — copy it to start a new example, so structure comes for free rather than arriving as a review comment.
  • .github/workflows/check.ymlprettier --check and ruff check on every pull request.
  • ruff.toml — line length 88, plus pyflakes and bugbear. Passes trivially until an example ships Python.
  • .claude/settings.json — points coding agents at STANDARDS.md when a session opens in this repo.

Reviewer notes

  • examples/reelestate/package.json declared "name": "rapidreels". Fixed.
  • Added engines to both Next examples (>=20, matching .nvmrc) and a format script to instagram-ai-video.
  • Four pre-existing files were reformatted so --check passes: instagram-ai-video/index.js, both postcss.config.js, and reelestate/pages/_document.tsx. No behaviour change.
  • .env.local.example in the Next examples is deliberate, not drift — Next loads .env.local. STANDARDS.md states that exception.

Verify

npx prettier@3 --check .   # All matched files use Prettier code style!
ruff check .               # All checks passed!

@vercel

vercel Bot commented Aug 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
reelestate Ignored Ignored Preview Aug 6, 2026 4:01am

@dazzatronus
dazzatronus force-pushed the example-standards branch 3 times, most recently from ab5b1dd to 3fd973f Compare August 6, 2026 04:00
@dazzatronus
dazzatronus merged commit fa06ce2 into master Aug 6, 2026
3 checks passed
@dazzatronus
dazzatronus deleted the example-standards branch August 6, 2026 04:03
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