mirror of
https://github.com/tinyhumansai/openhuman.git
synced 2026-07-28 13:32:23 +00:00
Steven EnamakelandGitHub
bfaabd3b86
* chore: update AlphaHuman version to 0.49.3 and configure updater plugin in tauri.conf.json - Bumped the AlphaHuman package version in Cargo.lock to 0.49.3. - Added updater configuration in tauri.conf.json to enable automatic updates with specified endpoints. * refactor: rename AlphaHuman to OpenHuman across the codebase - Updated all instances of "AlphaHuman" to "OpenHuman" in comments, tooltips, and constants to reflect the new branding. - Adjusted relevant documentation and prompts to ensure consistency with the new name. * refactor: update documentation and configurations to reflect OpenHuman branding - Replaced all instances of "AlphaHuman" with "OpenHuman" in documentation, comments, and configuration files to ensure consistency with the new branding. - Updated deep link URLs and related authentication flows to use the new "openhuman://" scheme. - Adjusted paths and references in the skills system and other related files to align with the new project name.te * refactor: standardize OpenHuman references and update configurations - Replaced all instances of "AlphaHuman" with "OpenHuman" across documentation, comments, and configuration files to maintain branding consistency. - Updated URLs and paths to reflect the new "openhuman://" scheme. - Adjusted environment variable names and related settings to align with the new project identity. - Enhanced documentation for clarity and accuracy regarding the OpenHuman framework.r * chore: update subproject commit reference in skills directory * refactor: update backend URL to reflect new service domain - Changed default backend URL from "https://api.openhuman.xyz" to "https://api.tinyhumans.ai" in both JavaScript and Rust configuration files. - Ensured consistency across the codebase regarding the new backend service endpoint. * feat: introduce identity and migration modules for OpenHuman - Added a new identity module to support AIEOS v1.1 JSON format, including structures for identity, psychology, linguistics, motivations, capabilities, physicality, history, and interests. - Implemented a migration module to facilitate data migration from OpenClaw memory, including SQLite and Markdown sources, with detailed reporting on migration statistics and warnings. - Established utility functions for handling multimodal content and image processing within the OpenHuman framework. - Enhanced the agent system with new dispatcher and classifier functionalities to improve tool management and message classification. * chore: remove Android project files and configurations - Deleted various Android project files including .editorconfig, .gitignore, build.gradle.kts, gradle.properties, and others to clean up the project structure. - Removed all related resources, layouts, and source files from the Android app directory to streamline the codebase. - This cleanup is part of a larger effort to refactor and simplify the project structure. * refactor: update login flow and remove Telegram integration - Removed the TelegramLoginButton component and its references from the OAuthLoginSection, streamlining the login options. - Updated the AppRoutes to remove the login route, reflecting changes in the authentication flow. - Enhanced the RotatingTetrahedronCanvas component with improved geometry and lighting effects for better visual presentation. - Adjusted the TypewriterGreeting component's styling for consistency. - Cleaned up the Welcome page to integrate the OAuthLoginSection directly, improving user experience. * chore: update subproject commit reference in skills directory * chore: update test configurations and improve test assertions - Modified test scripts in package.json to use a specific Vitest configuration file for consistency. - Updated assertions in loader tests to ensure loading durations are non-negative. - Enhanced tool loading tests to clarify expected behavior regarding localStorage and cache management. - Adjusted agent tool registry tests to improve error handling and ensure accurate statistics. - Refined device detection tests to reflect updated fallback URLs. * fix: enhance parameter formatting and remove unused components - Updated the `formatParameters` function to handle cases where schema properties are empty, returning a more informative response. - Deleted the `DownloadScreen` component and associated device detection utilities to streamline the codebase and remove unused functionality. - Adjusted tests to reflect changes in the tool loading and agent tool registry, ensuring accuracy in assertions. * chore: simplify Vitest configuration by removing unused include patterns - Updated the Vitest configuration to remove unnecessary test file patterns, streamlining the test setup for better clarity and maintainability. * refactor: update paths and comments for AI configuration and file watching - Modified Vite configuration to ignore only the `src-tauri` directory. - Updated logging messages to reflect the correct path for writing AI configuration files. - Adjusted fetch calls in the file watcher to use the new path for `TOOLS.md`. - Revised comments and logic in Rust code to clarify the handling of AI configuration file paths, including legacy fallback options. * chore: remove unused updater secrets from GitHub Actions workflow - Deleted UPDATER_GIST_URL and UPDATER_GIST_ID environment variables from the package-and-publish workflow, streamlining the configuration. * chore: comment out Vitest thresholds for clarity - Commented out the thresholds section in the Vitest configuration to improve clarity and maintainability, as it is currently not in use. * ran formatter * chore: update updater public key in tauri configuration - Replaced the existing public key in the updater plugin configuration with a new value to ensure proper functionality and security. * chore: update ESLint configuration and refactor components - Added `localStorage` and `sessionStorage` as readonly globals in ESLint configuration for better linting support. - Removed unused imports from `SkillsPanel.tsx` to clean up the code. - Changed the type of `watcherInterval` in `file-watcher.ts` for improved type safety. - Refactored toast management logic in `Intelligence.tsx` to enhance clarity and maintainability. - Simplified import statements in `IntelligenceProvider.tsx` for consistency. - Streamlined object property shorthand in `agentToolRegistry.ts` for cleaner code. * refactor: improve error handling and type safety in Intelligence component - Enhanced toast notification logic to defer state updates, preventing potential issues with setState in effects. - Updated the source filter dispatch to use a more specific type for improved type safety. * refactor: enhance type safety across various components and services - Updated type definitions from `any` to `unknown` in multiple files to improve type safety and prevent potential runtime errors. - Refactored state management in `TauriCommandsPanel` to use more specific types. - Adjusted context and parameters in several interfaces to ensure consistent typing. - Added ESLint directive to `polyfills.ts` for intentional global assignments. - Streamlined type handling in utility functions and API responses for better clarity and maintainability. * refactor: streamline import statements and improve code clarity - Consolidated import statements in `agentToolRegistry.ts` and `intelligenceSlice.ts` for better readability. - Simplified the `createTestStore` function in `test-utils.tsx` to enhance code conciseness. - Cleaned up the `isExecutionStepProgressEvent` function in `intelligence-chat-api.ts` for improved clarity and maintainability.
112 lines
4.9 KiB
Markdown
112 lines
4.9 KiB
Markdown
# Contributing to OpenHuman
|
||
|
||
Thank you for your interest in contributing. This document explains how to get set up, follow our workflow, and submit changes.
|
||
|
||
## Table of Contents
|
||
|
||
- [Code of Conduct](#code-of-conduct)
|
||
- [Getting Started](#getting-started)
|
||
- [Development Setup](#development-setup)
|
||
- [Git Workflow](#git-workflow)
|
||
- [Making Changes](#making-changes)
|
||
- [Submitting Changes](#submitting-changes)
|
||
- [Project Conventions](#project-conventions)
|
||
|
||
## Code of Conduct
|
||
|
||
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
||
|
||
## Getting Started
|
||
|
||
- Read the [README](README.md) and [ARCHITECTURE](ARCHITECTURE.md) for context.
|
||
- Check [open issues](https://github.com/tinyhumansai/openhuman/issues) and discussions for ideas and to avoid duplicate work.
|
||
- For security issues, see [SECURITY.md](SECURITY.md) — do not report vulnerabilities in public issues.
|
||
|
||
## Development Setup
|
||
|
||
### Prerequisites
|
||
|
||
- [Node.js](https://nodejs.org/) (LTS) and [Yarn](https://yarnpkg.com/)
|
||
- [Rust](https://rustup.rs/) (for Tauri and the Rust backend)
|
||
- Platform-specific tools for the targets you care about (e.g., Xcode for macOS/iOS, Android SDK for Android)
|
||
|
||
### Clone and Install
|
||
|
||
```bash
|
||
git clone https://github.com/YOUR_USERNAME/openhuman.git
|
||
cd openhuman
|
||
yarn install
|
||
```
|
||
|
||
Use your own fork in place of `YOUR_USERNAME` when cloning.
|
||
|
||
### Run the App
|
||
|
||
- **Web only**: `yarn dev` (Vite dev server, typically port 1420)
|
||
- **Desktop (Tauri)**: `yarn tauri dev` or `yarn dev:app` for enhanced debugging
|
||
- **Android**: `yarn tauri android dev`
|
||
- **iOS**: `yarn tauri ios dev`
|
||
|
||
See the main [README](README.md) and project docs for more commands (e.g., `yarn skills:build`, `yarn skills:watch`).
|
||
|
||
### Environment
|
||
|
||
Copy or create a `.env` from the documented template and set `VITE_BACKEND_URL`, `VITE_TELEGRAM_*`, and other `VITE_*` variables as needed. Do not commit secrets.
|
||
|
||
## Git Workflow
|
||
|
||
- **Fork** the [openhuman](https://github.com/tinyhumansai/openhuman) repository and work in your fork.
|
||
- **Base branch**: All pull requests must target the **`develop`** branch (not `main`).
|
||
- **No direct pushes** to the organization repo; all changes come in via pull requests from forks.
|
||
|
||
### Branch Naming
|
||
|
||
Use short, descriptive branches, e.g.:
|
||
|
||
- `fix/telegram-reconnect`
|
||
- `feat/settings-dark-mode`
|
||
- `docs/contributing-update`
|
||
|
||
## Making Changes
|
||
|
||
1. Create a branch from `develop`:
|
||
`git checkout develop && git pull origin develop && git checkout -b fix/your-change`
|
||
2. Make your changes. Keep commits focused and messages clear (e.g., “Fix socket reconnect on network drop”).
|
||
3. Follow our [project conventions](#project-conventions) and run checks before pushing.
|
||
|
||
### Running Checks
|
||
|
||
- **TypeScript**: `yarn compile` (or `tsc --noEmit`)
|
||
- **Lint**: `yarn lint` (ESLint); fix auto-fixable issues with `yarn lint:fix`
|
||
- **Format**: `yarn format:check`; format with `yarn format` (Prettier)
|
||
- **Tests**: `yarn test` (unit), `yarn test:rust` (Rust), `yarn test:e2e` (E2E when applicable)
|
||
|
||
Pre-commit/pre-push hooks (Husky) run formatting and linting; fix any failures before submitting.
|
||
|
||
## Submitting Changes
|
||
|
||
1. Push your branch to your fork:
|
||
`git push origin fix/your-change`
|
||
2. Open a **pull request** against **`develop`** in the [openhuman](https://github.com/tinyhumansai/openhuman) repository.
|
||
3. Fill in the PR template (if present): describe what changed, why, and how to test.
|
||
4. Link any related issues (e.g., “Fixes #123”).
|
||
5. Address review feedback and keep the PR up to date with `develop` (rebase or merge as the project prefers).
|
||
|
||
Maintainers will review and may request changes. Once approved, your PR will be merged into `develop`.
|
||
|
||
## Project Conventions
|
||
|
||
- **State**: Use Redux (and Redux Persist where needed). Avoid `localStorage`/`sessionStorage` for app or feature state; remove existing usage when touching related code.
|
||
- **Imports**: Use static `import`/`import type` at the top of the file. No dynamic `import()` for app code; use try/catch around Tauri API calls in non-Tauri environments instead.
|
||
- **Code style**: ESLint and Prettier are authoritative. Use type-only imports where appropriate and consolidate imports from the same module.
|
||
- **Telegram IDs**: Use the `big-integer` library; do not rely on native JavaScript numbers for Telegram IDs.
|
||
- **Tauri**: Commands are in Rust under `src-tauri`; frontend uses `invoke()` from `@tauri-apps/api/core`. Handle missing `window.__TAURI__` where the app can run outside Tauri.
|
||
- **Socket events**: Behavior exists in both the TypeScript frontend and the Rust backend. Any new socket event or protocol change must be implemented in both places.
|
||
- **Skills**: Follow the V8 runtime and skill manifest rules; respect platform compatibility and the documented bridge/API surface.
|
||
|
||
For more detail on architecture, patterns, and platform notes, see the project’s internal documentation (e.g., `CLAUDE.md` or equivalent contributor docs).
|
||
|
||
---
|
||
|
||
Thank you for contributing to OpenHuman.
|