Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (56 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

82 lines (56 loc) · 3.02 KB

Contributing to OCTO

Thanks for your interest in contributing to OCTO! 🐙 We welcome contributions of all sizes.

Getting Started

  1. Fork the repo and create your branch from main.
  2. Install dependencies — see the project's README for setup instructions.
  3. Make your changes — follow existing code style.
  4. Add tests — if you're fixing a bug or adding a feature, please add tests.
  5. Update docs — if behavior changes, update the README/docs accordingly.
  6. Open a Pull Request — fill in the PR template.

Development Workflow

  • All changes go through a Pull Request.
  • PRs must pass CI before merging (the Build and code-review checks are required).
  • PRs require approving reviews from maintainers before merging; review routing is automatic via .github/CODEOWNERS.
  • Keep your branch up to date with main — stale branches may miss required CI checks and need a rebase before they can merge.
  • We use squash-merge with a linear history to keep the log clean.

Review SLA

We aim to give every PR a fast first response so contributing here stays low-friction:

  • First review within 3 business days of a PR being opened (or updated out of draft).
  • If a PR needs changes, maintainers leave concrete, actionable feedback rather than a bare rejection.
  • If a PR is superseded or out of scope, maintainers close it with a short, polite explanation.
  • A PR with no maintainer response after 3 business days is fair game to ping in the thread or in Discussions — a nudge is welcome, not noise.

Maintainers: keep no open PR older than ~14 days without a first review. Triage oldest-first.

Commit Messages

Follow Conventional Commits:

feat: add user presence API
fix: resolve message ordering race condition
docs: update README install steps
chore: bump dependency versions

Pull Request Description

  • Describe what you changed and why.
  • Reference any related issues (e.g. Fixes #123).
  • Include screenshots for UI changes.
  • Write PR descriptions in English to keep the history accessible to the global community.

Code Style

  • Go: gofmt + golangci-lint
  • TypeScript/JavaScript: Prettier + ESLint (config in repo)
  • Swift: SwiftFormat
  • Kotlin: ktlint / Android Studio default

Reporting Bugs

Open a GitHub issue using the Bug Report template. Include:

  • Expected vs actual behavior
  • Steps to reproduce
  • Environment (OS, version, etc.)
  • Logs/screenshots if relevant

Suggesting Features

Open a GitHub issue using the Feature Request template. Explain the use case and why existing features don't solve it.

License

By contributing, you agree that your contributions will be licensed under the project's Apache License 2.0.

Questions?

Thanks for helping make OCTO better! 🚀