docs: add CONTRIBUTING.md documenting design philosophy and constraints#43
Merged
gordonmurray merged 1 commit intolance-format:mainfrom Apr 7, 2026
Merged
Conversation
Names the load-bearing design constraints that shape the project so that proposals touching them can be discussed against a written baseline rather than reconstructed in each thread. Covers: - Vanilla JS with no build step - GET-only, stateless API - No metadata database - No in-app authentication - Read-only access Also adds a short "proposing changes" section pointing to prior design discussions (lance-format#5, lance-format#29, lance-format#39) and a minimal development workflow snippet. Fixes lance-format#42
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
1 participant
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.
Fixes #42
Adds a one-page
CONTRIBUTING.mdthat names the load-bearing design constraints of the project:Each constraint has a sentence or two of reasoning so future proposals can be discussed against a written baseline rather than reconstructed in the thread.
Also includes:
docker build,docker run) so new contributors can get a local instance up without hunting through the README.