Add .env.example, expand dev guide, add env var drift check#9
Merged
MinecraftFuns merged 2 commits intomainfrom Feb 28, 2026
Merged
Add .env.example, expand dev guide, add env var drift check#9MinecraftFuns merged 2 commits intomainfrom
MinecraftFuns merged 2 commits intomainfrom
Conversation
…heck - Create .env.example with all 19 env vars and defaults from main.go - Expand docs/development.md with configure, docker-compose, Makefile targets - Add scripts/check-env-docs.sh to detect env var documentation drift - Add make check-docs target - Reference .env.example from docs/configuration.md Co-authored-by: MinecraftFuns <25814618+MinecraftFuns@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve onboarding documentation for contributors
Add .env.example, expand dev guide, add env var drift check
Feb 28, 2026
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.
New contributors had no quick-start env var template and no mechanism to detect when env vars are added to code without updating docs.
Changes
.env.example— All 19 env vars fromcmd/PromptPipe/main.gowith defaults and grouping. Copy-and-go for local dev.docs/development.md— Expanded with: configure step referencing.env.example, docker-compose usage, all Makefile targets, health check verification,make check-docsfor drift detection.docs/configuration.md— Reference to.env.example.scripts/check-env-docs.sh+Makefilecheck-docstarget — Drift guard that extracts env var names frommain.go(viaos.Getenv,ParseBoolEnv, etc.) and verifies each appears in both.env.exampleanddocs/configuration.md.Drift check
Fails loud if someone adds a new env var without updating docs.
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.