How to Contribute

We welcome contributors of all kinds—whether you want to improve our smart contracts, enhance the front-end, fix bugs, or help write documentation. Here's how to get started:

📁 Repo Structure

OmniSocial is structured as a monorepo using pnpm workspaces. The main directories include:

/contracts               → Solidity smart contracts (OmniWallet, DAO, PersonaNFT, etc.)
/frontend                → React front-end for OmniSocial dApp
/explorer                → Omnitopia Explorer interface
/subgraph                → The Graph subgraph code and schema
/scripts                 → Deployment, registration, and helper scripts
/docs                    → Markdown-based developer & user documentation
/packages/sdk            → (optional) SDK or GraphQL client utilities

🧑‍💻 How to Contribute Code

1. Fork & Clone

git clone https://github.com/OmniSocialBlockchain/omnisocial-monorepo.git
cd omnisocial-monorepo
pnpm install

2. Create a Feature Branch

git checkout -b feat/add-new-component

3. Commit Guidelines

Follow Conventional Commits:

feat: add tipping interface to FeedCard
fix: resolve bug with .omni alias resolution
docs: update contributing section

✅ Coding Standards

Solidity (contracts)

• Style: Solhint rules enforced

• Compiler version: ^0.8.20

• Named returns and NatSpec (@notice, @param) encouraged

• Use require() with clear revert messages

• Group state-changing functions at the top of each contract

JavaScript/TypeScript (frontend)

• Code style: ESLint with Prettier

• Framework: React + Next.js

• Styling: TailwindCSS

• i18n: Next-i18next

• Wallets: wagmi with viem and @rainbow-me/rainbowkit

🧾 Documentation Contributions

• All docs live in /docs (Markdown)

• Each section of the platform has its own .md file

• Use clear, beginner-friendly language

• PRs with typo fixes, formatting improvements, or new sections are welcome

🗣️ Communication & Feedback

• 💬 Discord – Ask questions, suggest features, get real-time help

• 🐛 GitHub Issues – Report bugs or request features

📦 Pull Request Checklist

Before submitting your PR:

• Run tests (pnpm test or forge test for contracts)

• Lint all files (pnpm lint)

• Document any new public contract functions

• Add new components or modules to relevant .md files

• Ensure all GitHub Actions pass

🏁 Start Here

1. Browse open issues

2. Comment if you want to take one

3. Open a PR when ready

4. Get feedback from core maintainers