mirror of
https://github.com/tinyhumansai/openhuman.git
synced 2026-07-28 13:32:23 +00:00
c2ff8b693b
* feat: add initial project structure and documentation - Introduced the GNU General Public License (GPL) v3 in LICENSE file. - Added MCP configuration in .claude/mcp.json for server integration. - Created architecture documentation in docs/ARCHITECTURE.md outlining the platform's design and components. - Defined MVP specifications in docs/MVP.md for the Telegram-based Agent Assistant. - Established API reference for team management in docs/teams-api-reference.md. - Set up basic HTML structure in public/index.html and added logo image in public/logo.png. * feat: add initial project documentation and HTML structure - Introduced CODE_OF_CONDUCT.md to establish community guidelines and standards for behavior. - Created CONTRIBUTING.md to outline contribution process, development setup, and project conventions. - Added SECURITY.md to define the security policy, supported versions, and reporting procedures for vulnerabilities. - Established basic HTML structure in index.html for the application interface. * chore: remove hello-python skill files - Deleted skill.json and skill.py files for the Hello Python example runtime skill, as they are no longer needed in the project. * feat: port tinyhuman agent runtime from ZeroClaw into Tauri backend Port daemon supervisor, health registry, security (policy, secrets, audit, pairing), agent traits, and config modules from ZeroClaw (MIT) into a new tinyhuman/ module under src-tauri/src/. The daemon auto-starts on desktop and shuts down gracefully on app exit via CancellationToken. - health: global HealthRegistry with component tracking and JSON snapshots - security/policy: SecurityPolicy with command validation, risk levels, rate limiting - security/secrets: ChaCha20-Poly1305 SecretStore with legacy XOR migration - security/audit: AuditLogger with JSON-line events and log rotation - security/pairing: PairingGuard with brute-force protection and SHA-256 hashing - security/traits: Sandbox trait + NoopSandbox - config: minimal DaemonConfig with autonomy, reliability, secrets, audit sub-configs - daemon: supervisor with health state writer emitting Tauri events - agent/traits: Provider, Tool, Memory, Observer, RuntimeAdapter traits + Noop impls - commands/tinyhuman: Tauri commands for health, security policy, encrypt/decrypt - 185 inline unit tests across all modules - README updated with custom inference/tunneling/memory positioning Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: update README to reflect AlphaHuman Mk1 branding and enhanced description - Changed project title to "AlphaHuman Mk1" for clarity. - Revised project description to emphasize user-friendly AI capabilities and the use of the Neocortex Mk1 model. - Removed outdated sections on custom inference, tunneling, and memory, streamlining the content for better readability. * update readme * Port zeroclaw runtime into tinyhuman * Replace CLI mentions with UI language * Split gateway module into smaller units * Split channels and config schema modules * Fix tinyhuman build, tests, and tunnel integration * feat(tinyhuman): add missing modules and ui-friendly services * refactor: rename tinyhuman to alphahuman * chore: remove bottom text from Welcome component * feat(settings): add tauri command console * feat(daemon): enhance daemon mode handling and integrate rustls with ring feature * feat(settings): implement comprehensive configuration management in TauriCommandsPanel * refactor(TauriCommandsPanel): streamline error handling and enhance async function usage * feat(settings): add skill management functionality to TauriCommandsPanel * style(TauriCommandsPanel): update input styles for improved readability and user experience * feat(settings): add Skills and Agent Chat panels with navigation and integration management * feat(settings): implement browser access management in SkillsPanel and enhance AgentChatPanel with local storage functionality --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
112 lines
5.0 KiB
Markdown
112 lines
5.0 KiB
Markdown
# Contributing to AlphaHuman
|
||
|
||
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/alphahumanxyz/alphahuman/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/alphahuman.git
|
||
cd alphahuman
|
||
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 [alphahuman](https://github.com/alphahumanxyz/alphahuman) 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 [alphahuman](https://github.com/alphahumanxyz/alphahuman) 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 AlphaHuman.
|