docs: add CONTRIBUTING.md guide for developer onboarding#479
Open
ayushsri-dev wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md guide for developer onboarding#479ayushsri-dev wants to merge 1 commit into
ayushsri-dev wants to merge 1 commit into
Conversation
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
This PR adds a dedicated
CONTRIBUTING.mdguide to the repository root. It provides new and existing contributors with clear instructions for environment setup, multi-module project navigation, local quality verification, and pull request submissions across Arvio's Android app, web frontend, serverless auth backend, and Cloudflare workers.Background & Motivation
While
README.mdcovers end-user feature overviews and initial Android setup, the repository previously lacked unified documentation for contributor workflows, git/commit practices, and local pre-submission validation commands (unit tests, static analysis, type checking).Adding
CONTRIBUTING.mdestablishes a single source of truth for developer onboarding without cluttering user-facing product documentation.What Changed
app/,web/,iosApp/,netlify-auth-site/,resolver-worker/,supabase/, anddocs/.playvssideload), ADB deployment, and sub-project commands (web/,resolver-worker/,netlify-auth-site/)../gradlew :app:testPlayDebugUnitTest), Kotlin static analysis (./gradlew detekt), web linting (npm run lint), worker type-checking (npm run typecheck), and backend tests (npm test)../gradlew assembleSideloadDebug) reproduces the automated GitHub Actions build check (.github/workflows/build-check.yml).README.mdfor Content And Source Policy and local secret proxy details,PRIVACY.mdfor data policy, andLICENSEfor Apache 2.0 terms.Local Verification
README.md#local-configuration,README.md#content-and-source-policy,.github/workflows/build-check.yml,PRIVACY.md,LICENSE).assemblePlayDebug,assembleSideloadDebug,compilePlayDebugKotlin,assemblePlayRelease,assembleSideloadRelease,testPlayDebugUnitTest,detekt) againstapp/build.gradle.kts.dev,build,start,lint,typecheck,test) againstpackage.jsonmanifests inweb/,resolver-worker/, andnetlify-auth-site/.Checklist
CONTRIBUTING.md).Closes #477