Skip to content

docs: add first-evening template setup guide - #21

Merged
fabianzimber merged 1 commit into
shiftbloom-studio:mainfrom
tasodoufu:docs/first-evening-template-guide
Aug 18, 2026
Merged

fabianzimber merged 1 commit into
shiftbloom-studio:mainfrom
tasodoufu:docs/first-evening-template-guide

Conversation

@tasodoufu

Copy link
Copy Markdown
Contributor

Problem

New users may clone the template repository itself and miss the required placeholder updates before their first publish.

Change

Adds a short README “First evening” section covering:

  • using Use this template or a fork to create a package repository;
  • the requested npm ci && npm test && npm run build verification;
  • the package/repository placeholders, Changesets config, and LICENSE attribution to update.

User impact

Template users get a concise first-use checklist without changing runtime behavior.

Verification

  • npm run lint
  • npm run typecheck
  • npm run test:ci
  • npm run build
  • git diff --check

The issue was rechecked immediately before push: it is OPEN, unassigned, has no comments indicating active work, and no open PR overlaps README.md.

Closes #17

@fabianzimber fabianzimber left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tasodoufu Thank you alot for the contribution. Looks good and clean 👍

@fabianzimber
fabianzimber merged commit 4f461b8 into shiftbloom-studio:main Aug 18, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add a First evening / Use this template section

2 participants