Thank you for your interest in contributing to OpenScan.AI! This guide will help you get started contributing to the codebase, documentation, and community.
Ways to contribute
- Code — Fix bugs, add features, and improve performance across the explorer backend, indexer, and frontend. All projects live under the OpenScanAI GitHub organization.
- Documentation — Improve these docs, fix typos, and add examples. Every page has an edit path into the website repository.
- API examples — Contribute scripts and integrations built on the REST API.
- Bug reports — File detailed issues with reproduction steps, expected vs. actual behavior, and environment details.
- Community support — Answer questions and help other developers integrate the API.
Repository map
| Area | Technologies | Good first issues look like |
|---|---|---|
| Explorer backend | Elixir, PostgreSQL | Endpoint fixes, schema tweaks |
| Indexer | Elixir, Erlang | Fetcher reliability, reorg handling |
| Frontend | TypeScript, React, Next.js | UI polish, accessibility, new views |
| Docs (this site) | Astro, MDX, Tailwind | Typos, examples, new guides |
Ground rules
- Follow the Code Conventions for the repository you touch.
- Use the
<type>: summarycommit format (fix: correct token holder pagination). - One logical change per pull request — see the Pull Request Process.
- Be respectful and constructive in issues, reviews, and discussions.
Getting help
- GitHub Discussions on the relevant repository — design questions and proposals
- X (Twitter) — @OpenScan_Ai for announcements
- Issues — bug reports and feature requests
In this section
- Getting Started — make your first contribution
- Backend & Indexer Setup — full development environment
- Frontend & Docs Setup — web development environment
- Code Conventions — style and standards
- Pull Request Process — from branch to merge
- Documentation Guide — writing for these docs