Replace boilerplate README with contributor-facing overview#65
Merged
lwwmanning merged 1 commit intomainfrom May 4, 2026
Merged
Replace boilerplate README with contributor-facing overview#65lwwmanning merged 1 commit intomainfrom
lwwmanning merged 1 commit intomainfrom
Conversation
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Will Manning <will@willmanning.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🔦 Lighthouse audit
Run |
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
Replaces the stock
create-next-appboilerplateREADME.md(which had been sitting unmodified since the repo was scaffolded) with a contributor-facing doc covering:bun run *script with a one-line description, including the gotcha thattypecheckmust run afterbuild(velite needs.velite/and Next emitsnext-env.d.tsduring the build).git commit -s), DCO probot enforcement note, plus pointers to CLAUDE.md for architectural context.The DCO mention is the load-bearing piece for an LF project: outside contributors landing on the repo cold need to know that an unsigned commit will be rejected at PR time, with the exact
git commit -sto use.Out of scope
LICENSEfile —package.jsonhas nolicensefield and the repo has noLICENSEat root. LF projects typically use Apache-2.0 but the choice belongs with the project's governance, not this PR. Worth a follow-up if it isn't intentional.CONTRIBUTING.md/CODE_OF_CONDUCT.md— common LF additions; can land separately once the README is in place.Test plan
🤖 Generated with Claude Code