Skip to content

Write a CONTRIBUTING.md guide for local Docker setup #9

Description

@SHAURYASANYAL3

🛑 The Problem

Open Source projects die without contributors, and contributors abandon projects if they can't get the app running locally within 10 minutes. Right now, setting up our Postgres database, Inngest server, and Next.js frontend is undocumented 'tribal knowledge'.

💡 The Solution

We need a comprehensive, copy-paste friendly CONTRIBUTING.md guide that holds the developer's hand from git clone to localhost:3000.

🛠️ Implementation Details

  1. Create CONTRIBUTING.md in the root of the repository.
  2. Write sections for:
    • Prerequisites (Node.js 18+, pnpm, Docker Desktop).
    • Installation (pnpm install).
    • Environment Variables (How to copy .env.example to .env).
    • Database Setup (How to run docker-compose up -d and pnpm db:push).
    • Running the App (pnpm dev).
  3. Include a Troubleshooting section for common errors (e.g., port 5432 already in use).

✅ Acceptance Criteria

  • The document is formatted beautifully with Markdown headers and code blocks.
  • A developer following the guide line-by-line ends up with a working local environment.
  • The guide is linked from the main README.md.

Ready to tackle this? Comment .take below to get automatically assigned!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions