Add CONTRIBUTING.md - #18
Merged
Merged
Conversation
This repo has never had contributor documentation. Written while documenting the initial local setup so the steps and pitfalls encountered along the way (docker-compose for a throwaway BookStack instance, Node version requirement, token setup, and the env-file gotcha) are captured before they're forgotten.
ttpears
self-requested a review
August 4, 2026 01:39
Owner
|
Nice, we'll need to cleanup the .env/dotenv setup so it's more intuitive. |
ttpears
approved these changes
Aug 4, 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
2 participants
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
This repo has never had a CONTRIBUTING.md. This one was written directly from the process of documenting the initial local setup, so it reflects what was actually encountered rather than an idealized version of the workflow.
It covers six areas:
Note on a real bug found during setup
One of the Gotchas documents that
npm run dev(tsx src/index.ts) does not load.envat all — there's nodotenvimport or--env-fileflag anywhere in the repo, so following the documented setup steps silently fails to configure the server. The workaround isnode --env-file=.env --import tsx src/index.ts. This is a real bug, already reported separately from this PR; it's called out here for anyone doing local setup in the meantime, not being fixed as part of this change.Test plan