docs: improve contributing and environment documentation#3613
Open
IamCoder18 wants to merge 1 commit into
Open
docs: improve contributing and environment documentation#3613IamCoder18 wants to merge 1 commit into
IamCoder18 wants to merge 1 commit into
Conversation
Contributor
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Executive SummaryAll 5 duplicate variable entry warnings from the previous review have been resolved; Files Reviewed (2 files)
Reviewed by claude-4.6-sonnet-20260217 · 689,179 tokens Review guidance: REVIEW.md from base branch |
5dc58b7 to
1b92282
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
N/A
Visual Changes
N/A
Reviewer Notes
N/A