Skip to content

docs: add contributor onboarding guide (XcodeGen + Gradle) - #364

Merged
maugauwi-hash merged 1 commit into
ethos-protocol:mainfrom
rudeus112266:docs/304-contributor-onboarding
Aug 31, 2026
Merged

docs: add contributor onboarding guide (XcodeGen + Gradle)#364
maugauwi-hash merged 1 commit into
ethos-protocol:mainfrom
rudeus112266:docs/304-contributor-onboarding

Conversation

@rudeus112266

Copy link
Copy Markdown
Contributor

Summary

Adds docs/contributor-onboarding.md, a minimal "get a debug build running" path for both iOS (XcodeGen) and Android (Gradle), distilled from README.md's full Setup section.

Context

README.md's Setup section is accurate but dense — nine numbered iOS steps alone, mixing local-dev essentials with release-signing and certificate-pinning specifics. New contributors only need a small subset of that to get a debug build running. This doc:

  • Gives the minimal per-platform steps to a working debug build
  • Explicitly calls out which README.md steps are release-only and safe to skip for local dev (iOS steps 5-8; Android steps 2, 3, 5)
  • Links back to README.md for the full setup/testing steps once a contributor is ready to go beyond first-run

Testing

Documentation-only change. Cross-checked each "skip for local dev" callout against the current README.md Setup section and the CI pin-check scripts to confirm debug builds are genuinely exempt.

Closes #304

@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

@rudeus112266 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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 Onboarding Guide for New Contributors Covering Both XcodeGen and Gradle Setup

2 participants