Skip to content

docs: add comprehensive CONTRIBUTING guide for mobile contributors - #1

Open
adesuwa-tech wants to merge 1 commit into
mainfrom
docs/add-contributing-guide
Open

docs: add comprehensive CONTRIBUTING guide for mobile contributors#1
adesuwa-tech wants to merge 1 commit into
mainfrom
docs/add-contributing-guide

Conversation

@adesuwa-tech

Copy link
Copy Markdown
Owner

Summary

Adds a complete CONTRIBUTING.md to help new mobile contributors get up and running quickly with the Expo app.

Changes

  • Prerequisites — Node.js v18+, npm v9+, Expo CLI, Expo Go (and optional simulator setup)
  • Installation — step-by-step clone, npm install --legacy-peer-deps, and .env setup
  • Running the appnpm start plus android, ios, and web shortcuts
  • Project structure — annotated directory tree covering app/, src/, docs/, and test folders
  • Testingnpm test / npm run test:watch, UI testing expectations (jest-expo + RNTL), mocking patterns
  • UI & Design guidelines — link to design system, token import rules, dark-only palette note
  • Accessibility — checklist highlights, touch targets, contrast, screen reader annotations
  • Security — key handling rules, no-commit reminder, link to Security Guide
  • PR checklist — branch naming, commit message format, push, and review steps

What was tested

  • Verified all linked docs (docs/design-system.md, docs/accessibility.md, docs/security.md, docs/storage.md) exist in the repo.
  • Confirmed npm install --legacy-peer-deps and npm start / npm test scripts match package.json.
  • Markdown renders cleanly with correct headings, table, and code blocks.

Closes

Closes Axionvera#3

- Add prerequisites section: Node.js v18+, npm v9+, Expo CLI, Expo Go
- Add installation steps with --legacy-peer-deps flag
- Add run commands (npm start, android, ios, web)
- Add UI testing expectations using jest-expo and RNTL
- Add design system, accessibility, and security guidelines
- Add PR submission checklist with branch, commit, and review steps

Closes Axionvera#3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING guide for mobile contributors

1 participant