Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (42 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 2.09 KB

contributing

thanks for wanting to help out. here's how to get going.

heads up - this project uses a katana-themed naming system. check docs/naming.md before diving in so the folder names make sense.

setup

  1. clone the repo
  2. install bun, rust, and a c++ compiler (g++ or clang)
  3. cd habaki && bun install
  4. cargo tauri dev to start the app

project structure

  • habaki/menuki/ - frontend (svelte + typescript)
  • habaki/src-tauri/ - backend (rust, tauri)
  • habaki/src-tauri/blades/ - blade logic (c++)
  • habaki/src-tauri/common/ - shared c utilities
  • ito/ - config data (country info, age brackets, scoring params)
  • tests/ - c++ unit tests (catch2)
  • docs/ - documentation

running tests

cd tests
cmake -B build
cmake --build build
ctest --test-dir build --output-on-failure

making changes

  • fork the repo and make a branch
  • keep PRs small and focused
  • make sure tests pass before submitting
  • if you're adding new c++ logic, add tests for it
  • match the existing code style

language rules

all logic lives outside the frontend. the frontend (svelte/typescript) is strictly for rendering and calling backend commands. no business logic, no calculations, no data processing in typescript.

  • c++ - blade logic, scoring algorithms, data processing
  • rust - app shell, FFI bridge, file I/O, anything security-sensitive
  • c - low-level utilities, OS-level operations, shared glue code
  • go - network-related features (background daemons, connectivity)
  • typescript/svelte - UI only. display data, handle user input, call tauri commands

blades

each blade is a self-contained feature module. if you want to add a new blade, look at how timeshift is structured and follow the same pattern.

non-code contributions

you don't need to code to help out. check the data guide for how to contribute country data, fix sleep times, or report inaccurate scores.

reporting bugs

open an issue. include what happened, what you expected, and steps to reproduce. screenshots help.