Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
145 lines (108 loc) · 5.01 KB

CONTRIBUTING.md

File metadata and controls

145 lines (108 loc) · 5.01 KB
Raw

Contributing to Corin

Thank you for your interest in contributing! This guide covers the essentials.

Prerequisites

Tool Version Notes
Rust stable (latest) rustup update
Node.js 22+ nvm install 22
npm bundled with Node.js
Tauri CLI 2.x cargo install tauri-cli
uteke-serve latest Auto-started by Corin; install via cargo install uteke --features serve

Platform dependencies: Tauri requires platform-specific system libraries (webkit2gtk on Linux, etc.). See Tauri Prerequisites for your platform.

Setup

# Clone
git clone https://github.com/codecoradev/corin.git
cd corin
git checkout develop

# Install frontend deps
npm install

# Run in dev mode (starts uteke-serve automatically)
npm run tauri dev

Project Structure

corin/
├── src/                     # Svelte 5 frontend
│   └── lib/
│       ├── components/      # UI components
│       ├── stores/          # Svelte 5 reactive stores
│       └── ts/              # TypeScript types + IPC wrappers
├── src-tauri/               # Rust backend
│   └── src/
│       ├── commands.rs      # Tauri IPC command handlers
│       ├── uteke_client.rs   # Uteke HTTP API client
│       ├── connections/      # Connection manager module
│       └── config.rs         # App configuration
├── docs/                    # Documentation
│   ├── architecture.md      # System architecture
│   ├── roadmap.md           # Feature roadmap
│   └── mcp-integration.md   # MCP setup guide
├── AGENTS.md                # Pre-push checklist (for AI agents & humans)
└── CHANGELOG.md             # Release changelog

Branch Strategy

Branch Purpose Protection
develop Default branch, all work merges here PR + CI checks required
main Release branch, tags cut from here PR + CI checks required
feat/<issue>-<name> Feature branches Created from develop

Never push directly to develop or main. Always use a branch + PR.

Pre-push Checklist

Run ALL checks locally before pushing. See AGENTS.md for the full checklist.

# Rust (from src-tauri/)
cargo fmt --all -- --check      # format
cargo clippy -- -D warnings     # lint
cargo test                      # unit tests

# Frontend (from project root)
npx svelte-check --tsconfig ./tsconfig.json  # type check
npm run test -- --run           # vitest
npm run build                   # production build

If ANY check fails — do NOT push. Fix locally first.

Commit Style

Use Conventional Commits:

feat: add document tree navigation
fix: resolve namespace filter state leak
perf: cache namespace counts with 30s TTL
docs: update architecture diagram
refactor: extract connection adapter trait

Pull Request Process

  1. Create a feature branch from develop: git checkout -b feat/123-my-feature
  2. Implement + test locally (run full pre-push checklist)
  3. Push and open a PR targeting develop
  4. CI must pass: type check, build, test, format, clippy, Cora review
  5. PR is mergeable when all checks are green

Adding a New Feature (5-File Pattern)

When adding a new API surface (e.g., documents, tags, kanban), update all 5 files:

# File What to add
1 uteke_client.rs Structs + HTTP client methods
2 commands.rs #[tauri::command] wrappers
3 lib.rs Register in generate_handler![]
4 types.ts TypeScript interfaces
5 ipc.ts invoke wrappers

Release Process

Managed by maintainers. Tags cut from main only via release workflow.

Questions?

Open an issue on GitHub.

CLA

All contributions (code, docs, tests, configuration) require a signed Contributor License Agreement before a pull request can be merged:

The CLA is a license agreement, not a copyright assignment — you keep ownership of your work. Signing takes a couple of minutes and is stored in the codecoradev/.github repository; a bot checks it automatically on every pull request.

Contributions are unpaid

Contributing to this project is voluntary and unpaid. There is no compensation, payment, bounty, or financial reward of any kind for contributions — now or in the future. You contribute on your own time, at your own discretion, because you want to improve the project.

If any paid-contribution program is ever introduced, it will be announced explicitly and this document will be updated. Until then, assume every contribution is volunteer work under the MIT license terms above.