Skip to content

CONTRIBUTING.md does not describe how to set up the project locally from scratch #296

Description

@grantfox-oss

Summary

CONTRIBUTING.md focuses on the blueprint contribution workflow but does not explain how to get the project running locally. A new contributor who clones the repository and reads the contributing guide will find no instructions for installing dependencies, configuring environment variables from .env.example, running database migrations, seeding test data, or starting the development server. The first-run experience is effectively undocumented.

What a Contributor Needs to Deliver

CONTRIBUTING.md must be updated to include a complete local setup section covering: cloning the repository, installing Node.js dependencies with npm install, copying .env.example to .env and documenting the minimum required variables for local development, running npm run dev for the basic dashboard, and optionally running npm run dev:ws for the full WebSocket server. The section should note that PostgreSQL and Redis are optional for local development with the mock data path. The blueprint contribution workflow already documented should remain unchanged.

Metadata

Metadata

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaignOfficial Campaign | FWC26Campaign: Official Campaign | FWC26documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions