Back to Omi

Contribution Guide

docs/doc/developer/Contribution.mdx

3.0.0-Android-App3.7 KB
Original Source

How to Contribute

<Steps> <Step title="Fork the Repository"> Go to [github.com/BasedHardware/Omi](https://github.com/BasedHardware/Omi) and click **Fork**. </Step> <Step title="Make Your Changes"> Clone your fork, create a branch, and implement your changes. </Step> <Step title="Create a Pull Request"> Submit a PR and specify which issue it relates to. </Step> </Steps>

Documentation Contributions

Docs contributions are just as important as code contributions! Our docs are located in the GitHub docs folder and sync in real-time with docs.omi.me.

<Tip> You can edit docs directly from GitHub: Fork the repo → [click the edit icon](https://share.cleanshot.com/dkBSffGr) → click "Preview" → create a pull request. </Tip>

Contribution Rewards

Get rewarded for approved PRs with significant contributions:

<CardGroup cols={2}> <Card title="1 PR" icon="gift"> Free DevKit device (necklace or glasses, depending on contribution area) </Card> <Card title="2 PRs" icon="coins"> $100 of transcription credits </Card> <Card title="5 PRs" icon="star"> $500 of transcription credits + special Contributor role in Discord </Card> <Card title="10 PRs" icon="plane"> Trip to San Francisco to hang out with the Based Hardware team </Card> </CardGroup>

What Qualifies as a Significant Contribution?

<AccordionGroup> <Accordion title="Time Investment" icon="clock"> Something you spent 5+ hours on. Can be multiple smaller contributions that add up. </Accordion> <Accordion title="Impact" icon="bolt"> Either a new feature or a major bug fix. </Accordion> <Accordion title="Quality" icon="check"> Quality code with clear explanations. </Accordion> </AccordionGroup> <Info> To claim your reward, email [[email protected]](mailto:[email protected]) with: - List of your contributions - Your address - Email and phone number </Info>

Get paid to improve AI wearables!

<Card title="View Paid Bounties" icon="money-bill" href="https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue+label:%22Paid+Bounty+%F0%9F%92%B0%22"> Browse open issues with the "Paid Bounty" label </Card>

Bounty Rules

RuleDescription
Code must be mergedYour code must be merged into the master branch
EligibilityBounty eligibility is solely at our discretion
Locking a taskYou can "lock" a bounty task, but only after your first PR is merged
Claiming paymentEmail [email protected] with bounty link + PayPal account

No Bounties Available?

If there are no paid bounties available, you can suggest your own:

<Steps> <Step title="Browse Open Issues"> Filter by [open issues](https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue) without the "bounty" label. </Step> <Step title="Suggest a Bounty"> Comment on the issue and ping @josancamon19 or @kodjima33 with your bounty suggestion. </Step> </Steps>

Get Started

<CardGroup cols={2}> <Card title="GitHub Issues" icon="github" href="https://github.com/BasedHardware/Omi/issues"> Browse all open issues </Card> <Card title="Paid Bounties" icon="money-bill" href="https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue+label:%22Paid+Bounty+%F0%9F%92%B0%22"> View issues with bounties </Card> <Card title="Discord" icon="discord" href="http://discord.omi.me"> Join the community </Card> <Card title="Documentation" icon="book" href="https://github.com/BasedHardware/Omi/tree/main/docs"> Contribute to docs </Card> </CardGroup>