docs: open-source contribution infrastructure#2
Merged
Conversation
Add the docs and GitHub scaffolding needed for external contributors: - README with project overview, branch strategy, and quick start - CONTRIBUTING with setup, build/test commands, and PR guidelines - MIT LICENSE, Contributor Covenant, and SECURITY policy - GitHub issue templates (bug, feature), PR template, OAuth CI workflow - Typecheck script and tsconfig for vercel-notion-auth Co-authored-by: Kaung <kaungzinye@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
All contributor docs now target main only. Adds guidance on when a staging branch would be worth adding later (TestFlight gating, etc.). Co-authored-by: Kaung <kaungzinye@users.noreply.github.com>
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
Makes the repository ready for open-source contribution on
mainas the single public branch.What's included
Documentation
main)stagingwould be worth adding laterGitHub templates
mainCI
vercel-notion-auth/Branch strategy
Recommendation: use
mainonly for publish + contributions. Nostaginguntil you need TestFlight integration gating or multi-maintainer release trains.Before publishing
Merge
001-notion-task-app→mainand set GitHub default branch tomain. This PR's README assumes the iOS app is already onmain.Testing
npm ci && npm run typecheckinvercel-notion-auth/