docs: improve contributing and environment documentation#3613
docs: improve contributing and environment documentation#3613IamCoder18 wants to merge 2 commits into
Conversation
Code Review SummaryStatus: 1 Issue Found | Recommendation: Address before merge Executive Summary
Overview
Issue Details (click to expand)WARNING
Resolved Issues
Files Reviewed (3 files)
Fix these issues in Kilo Cloud Reviewed by claude-sonnet-4.6 · incremental review Review guidance: REVIEW.md from base branch Reviewed by claude-4.6-sonnet-20260217 · 414,085 tokens Review guidance: REVIEW.md from base branch |
5dc58b7 to
1b92282
Compare
1b92282 to
356c166
Compare
356c166 to
7af6391
Compare
|
I've verified most of my changes by following all given instructions while working on another PR except the seeding-related instructions. The ENVIRONMENT.md remains only verified by AI. Additionally, while testing, I noticed that there are two more required environment variables ( This PR is now read for review. |
Summary
Added two documentation files to lower the barrier for community contributors:
CONTRIBUTING.md— a practical onboarding guide covering prerequisites, local development setup, database seeding withpnpm dev:seed, and common development commands. Addresses the gap where the previous guide was macOS-focused and lacked concrete local testing tooling references.ENVIRONMENT.md— a comprehensive reference of all environment variables used across the monorepo, organized by domain (App, KiloClaw, Cloud Agent, etc.) with descriptions of what each variable activates. Provides the transparency needed for non-employees to understand which keys are required for specific product surfaces without access tovercel env pull.These changes directly address the onboarding and environment documentation gaps raised in #3510, making it easier for external contributors to set up their environment and understand what each configuration variable does.
Closes #3510
Verification
I've manually verified my changes. Read my comment below.
Visual Changes
N/A
Reviewer Notes
N/A