Skip to content

docs: improve contributing and environment documentation#3613

Open
IamCoder18 wants to merge 1 commit into
Kilo-Org:mainfrom
IamCoder18:feat/issue-3510-contributing-onboarding
Open

docs: improve contributing and environment documentation#3613
IamCoder18 wants to merge 1 commit into
Kilo-Org:mainfrom
IamCoder18:feat/issue-3510-contributing-onboarding

Conversation

@IamCoder18
Copy link
Copy Markdown

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 with pnpm 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 to vercel 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

N/A

Visual Changes

N/A

Reviewer Notes

N/A

Comment thread ENVIRONMENT.md Outdated
Comment thread ENVIRONMENT.md Outdated
Comment thread ENVIRONMENT.md Outdated
Comment thread ENVIRONMENT.md Outdated
Comment thread ENVIRONMENT.md Outdated
@kilo-code-bot
Copy link
Copy Markdown
Contributor

kilo-code-bot Bot commented Jun 1, 2026

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Executive Summary

All 5 duplicate variable entry warnings from the previous review have been resolved; ENVIRONMENT.md now documents each variable exactly once.

Files Reviewed (2 files)
  • CONTRIBUTING.md — no issues
  • ENVIRONMENT.md — all previous duplicate entries removed

Reviewed by claude-4.6-sonnet-20260217 · 689,179 tokens

Review guidance: REVIEW.md from base branch main

@IamCoder18 IamCoder18 force-pushed the feat/issue-3510-contributing-onboarding branch from 5dc58b7 to 1b92282 Compare June 1, 2026 01:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improving the Community Contributing & Local Onboarding Experience

1 participant