-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
laterMaybe laterMaybe later
Description
Problem
The current contribution documentation is missing important information for first-time contributors trying to set up the local development environment.
Issues
1. Missing pnpm dev instructions
There are no clear instructions on how to start the development server. Contributors need guidance on the pnpm dev command and where to run it from.
2. Environment variables error on first run
When running the development server for the first time, contributors encounter an error about invalid/missing environment variables:
❌ Invalid environment variables: [{...},{...}]
There should be documentation explaining:
- Which environment variables are required
- How to set up the
.env.localfile - Example
.env.local.examplefile or clear instructions
Suggested Improvements
- Add a "Getting Started" section in the contribution guide with step-by-step instructions
- Document the
pnpm devcommand and any prerequisites - Explain environment variable setup with examples
- Consider adding a setup script or improving error messages to guide new contributors
Metadata
Metadata
Assignees
Labels
laterMaybe laterMaybe later