Skip to content

fix(docs): update contributor guide for current workspace - #53

Merged
Hydralerne merged 1 commit into
oblien:mainfrom
4305Labs:docs/update-contributor-guide
Jul 20, 2026
Merged

fix(docs): update contributor guide for current workspace#53
Hydralerne merged 1 commit into
oblien:mainfrom
4305Labs:docs/update-contributor-guide

Conversation

@4305Labs

Copy link
Copy Markdown
Contributor

Motivation

The contributor guide described an outdated three-service development setup,
omitted current workspaces, and included stale environment and database commands.

Changes

  • document the pinned Bun and Node.js prerequisites
  • distinguish app-local development from the Docker Compose stack
  • document the current scoped development scripts
  • update the complete apps and packages workspace map
  • correct the Drizzle Studio command and verification guidance

Verification

  • bun install --frozen-lockfile --ignore-scripts
  • bun run --cwd apps/api lint
  • bun run --cwd packages/core test
  • bun run --cwd packages/core build
  • Turbo dry-runs for the documented development, test, and build tasks
  • docker compose config --services
  • prettier --check CONTRIBUTING.md
  • git diff --check

Full workspace test/build execution was not run because email lifecycle
dependencies were intentionally skipped for this documentation-only change.

Related to #8

@4305Labs
4305Labs marked this pull request as ready for review July 20, 2026 13:39
@4305Labs 4305Labs changed the title docs: update contributor guide for current workspace docs(contributing): update contributor guide for current workspace Jul 20, 2026
@4305Labs 4305Labs changed the title docs(contributing): update contributor guide for current workspace fix(docs): update contributor guide for current workspace Jul 20, 2026
@Hydralerne
Hydralerne merged commit a78cf47 into oblien:main Jul 20, 2026
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.

2 participants