makeplane / makeplane/plane

Setup docs drift: DATABASE_URL, PORT, REDIS_URL missing from CONTRIBUTING.md

Open
#9,302 2 comments 0 reactions 1 assignee View on GitHub

@akshat5302 is already working on this.

Since Jul 1, 2026.

Dominant language
TypeScript
Stars
59.6k
Forks
5.8k
Avg merge
1d 22h
Merged PRs (30d)
49

Description

Hi — found a concrete contributor onboarding gap while comparing config files against docs:

.env.example:2-56 defines DATABASE_URL, PORT, and REDIS_URL as required — CONTRIBUTING.md:48-83 mentions neither

A new contributor clones the repo, misses these vars, and hits connection failures on first run with no clear pointer to what's missing.

Proposed fix — add to the Environment Setup section in CONTRIBUTING.md:

DATABASE_URL=postgresql://...
PORT=3000
REDIS_URL=redis://localhost:6379

Happy to open a PR if confirmed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.