Skip to content

Contributing Guide

Thank you for improving Own DevStudio! This page explains the fastest path to a great contribution—whether code, docs, or community support.

Ground rules

  • Follow the Code of Conduct.
  • Prefer small, focused PRs with clear motivation.
  • Focus on fixing bugs or adding core features.
  • Keep docs in sync with behavior and changes.

Setup (For Documentation)

Tech Stack

This documentation site uses MkDocs + Material.

# 1) Create & activate a virtual env (optional but recommended)
python -m venv .venv && source .venv/bin/activate

# 2) Install deps
pip install mkdocs-material mkdocs-minify-plugin mkdocs-git-revision-date-localized-plugin

# 3) Run locally
mkdocs serve
# Open http://127.0.0.1:8000
  1. Create a branch: git checkout -b documentation/fix-typo-install
  2. Edit Markdown files under documentation/
  3. Check locally with mkdocs serve
  4. Commit using Conventional Commits
  5. Open a PR

Setup (App / Repo)

Development Setup Steps

The project is evolving. After the successful Alpha stage, more details will be available soon.

Issue workflow

  • Bug report → Use the template, include OS, ODS version, logs, repro steps, and expected vs actual behavior.
  • Feature request → Explain the problem first, then the solution. Share screenshots or mockups.

Pull request checklist

  • Clear title & description (what/why, not just how)
  • Linked issue (if applicable)
  • Tests and/or manual verification notes
  • Docs updated (user-visible changes)
  • Passes lint/format/build (if applicable)

Commit style (Conventional Commits)

Examples:

feat(editor): add multi-cursor column selection
fix(terminal): restore cwd after restart
docs(install): clarify mkdocs-material setup
refactor(ai): extract model registry hook
test(cli): add snapshot for `ods init`

Security issues

Security

Do not file public issues for security bugs.. We’ll create a seperate channel for this and coordinate to fix.

Recognition

Consistent contributors may be invited to maintainership. Also highlight notable contributions in the Release Notes and social channels.