docs: document DATABASE_URL, PORT, and REDIS_URL in CONTRIBUTING.md#9411
docs: document DATABASE_URL, PORT, and REDIS_URL in CONTRIBUTING.md#9411pranav-afk wants to merge 1 commit into
Conversation
New contributors hit connection failures when required env vars from apps/api and apps/live .env.example files are not explained in the setup guide. Document what setup.sh copies, the key variables with defaults that match the local Docker Compose stack, and local service ports. Fixes makeplane#9302
|
|
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Caution Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted. Error details |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
76-77: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winClarify the execution context for Live’s Redis default.
redis://localhost:6379/works when Live runs on the host, but not when Live runs inside a container; in that case it should use the Docker service hostname (for example,plane-redis). Please state that this default assumes host-run Live, or document the containerized alternative. (raw.githubusercontent.com)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CONTRIBUTING.md` around lines 76 - 77, The REDIS_URL documentation in CONTRIBUTING.md currently presents Live’s localhost default without describing its execution context. Update the REDIS_URL entry to state that redis://localhost:6379/ applies when Live runs on the host, and document the containerized alternative using the Docker service hostname such as plane-redis.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 76-77: The REDIS_URL documentation in CONTRIBUTING.md currently
presents Live’s localhost default without describing its execution context.
Update the REDIS_URL entry to state that redis://localhost:6379/ applies when
Live runs on the host, and document the containerized alternative using the
Docker service hostname such as plane-redis.
2 participants
Description
Documents the required environment variables that new contributors need after
setup.sh, so first-time local setup is less likely to fail with unclear connection errors.setup.shcopies each service.env.example→.envand generates the APISECRET_KEYDATABASE_URL,REDIS_URL, andPORTwith locations and defaults taken fromapps/api/.env.exampleandapps/live/.env.example(aligned with the local Docker Compose stack)Type of Change
Screenshots and Media (if applicable)
Test Scenarios
CONTRIBUTING.mdand confirm the Environment variables section appears after thesetup.shstepapps/api/.env.exampleandapps/live/.env.exampleReferences
Summary by CodeRabbit