Contributing

​

Getting Started

git clone https://github.com/YOUR_USERNAME/soundcheck-mobile-app
cd soundcheck-mobile-app

git remote add upstream https://github.com/soundchecklive/soundcheck-mobile-app

npm install

​

Branching Strategy

​

Branch Naming

​

Branch Flow

feature/your-feature
     │
     └──► dev ──► qa ──► main (prod)

​

Development Workflow

git checkout dev
git pull upstream dev
git checkout -b feature/your-feature

npm run check-all

git add .
git commit -m "feat: add your feature description"

git push origin feature/your-feature

​

Commit Messages

​

Examples

feat: add Apple Sign In to login screen
fix: resolve OAuth redirect issue on Android
docs: update API authentication guide
refactor: extract event validation to separate module

​

Code Style

​

TypeScript

• Strong typing required (avoid any)
• Use interfaces for object shapes
• Use types for unions and utilities

​

React

• Functional components with hooks
• Memoize expensive computations
• Keep components focused and small

​

Imports

// 1. External libraries
import React, { useState } from 'react';
import { View } from 'react-native';

// 2. Internal aliases (@/)
import { Button } from '@/components/ui';
import { useAuth } from '@/lib/context/AuthContext';

// 3. Relative imports
import { MyComponent } from './MyComponent';

​

Pre-Commit Hooks

• TypeScript type checking
• oxlint on staged files
• oxfmt on staged files
• Whitespace error detection
• TypeScript checks on staged files (mobile, web, api-events, mcp-ts, …)

git commit --no-verify

​

Pull Request Guidelines

​

PR Title

• Use conventional commit format
• Keep under 72 characters
• Be descriptive

​

PR Description

• What changes were made
• Why the changes were made
• How to test the changes
• Screenshots for UI changes

​

Review Process

1. Open PR targeting dev
2. Wait for CI checks to pass
3. Request review from team members
4. Address feedback
5. Merge when approved

​

Testing

​

Mobile

npm run type-check
npm run lint

​

Web

cd web
npm run typecheck
npm run lint
npm test

​

API (api-events)

cd api-events
npm run checks   # typecheck + lint + test:coverage
npm test         # unit tests only

​

MCP server (mcp-ts)

cd mcp-ts
npm run typecheck
npm test

​

Documentation

• Update docs when adding features
• Keep README files current
• Add JSDoc comments for complex functions

​

Need Help?

• Create an issue for bugs or questions
• Check existing issues before creating new ones
• Join team discussions for architectural decisions