docs: improve contributor env setup#58
Merged
Obiajulu-gif merged 1 commit intoJun 21, 2026
Merged
Conversation
Collaborator
|
@OkeyAmy great work |
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.
Closes #20
Summary
.env.examplewith placeholder-only values so contributors can run the app without maintainer API keys or secrets.Description
.env.examplecontains the full suggested set of safe variables and mock flags only.README.mdLocal Development instructions to showcp .env.example .env.local, explain that.env.exampleis tracked while.env*is ignored, and recommendENABLE_MOCK_PAYMENTS,ENABLE_MOCK_EMAILS, andENABLE_MOCK_STELLARfor contributors.CONTRIBUTING.mdwith environment categories that classify variables as required, optional, mock-only, or planned for Stellar, and reinforce contributor safety rules around secrets..gitignorecontinues to exclude.env*while allowing.env.exampleto be tracked.