Contributing Guide

January 23, 2026 · View on GitHub

Thank you for your interest in the WorkAny project! We welcome all forms of contributions, including but not limited to:

Bug reports
Feature requests
Code fixes or new features
Documentation improvements
Translations

Code of Conduct

Please be kind and respectful when participating in this project. We are committed to providing an open and inclusive environment for everyone.

How to Contribute

Reporting Bugs

Search Issues to check if a similar issue already exists
If not, create a new Issue
Use a clear title to describe the problem
Provide the following information:
- Operating system and version
- WorkAny version
- Steps to reproduce
- Expected behavior vs actual behavior
- Relevant error logs or screenshots

Submitting Feature Requests

Search Issues to check if a similar request already exists
Create a new Issue with a title starting with [Feature]
Describe the feature requirements and use cases in detail
If possible, provide implementation ideas

Submitting Code

Prerequisites

Fork this repository

Clone your fork:

git clone https://github.com/YOUR-USERNAME/workany.git
cd workany

Add the upstream repository:

git remote add upstream https://github.com/workany-ai/workany.git

Install dependencies:
```
pnpm install
```

Development Workflow

Sync with upstream:

git fetch upstream
git checkout main
git merge upstream/main

Create a feature branch:

git checkout -b feature/your-feature-name
# or for fixes
git checkout -b fix/issue-description

Make your changes, ensuring:
- Consistent code style
- Necessary tests are added
- Related documentation is updated

Commit your changes:

git add .
git commit -m "feat: add your feature description"

Push to your fork:

git push origin feature/your-feature-name

Create a Pull Request

Commit Convention

Use semantic commit messages:

feat: New feature
fix: Bug fix
docs: Documentation update
style: Code formatting (no functional changes)
refactor: Code refactoring
perf: Performance improvement
test: Test related
chore: Build/tooling related

Examples:

feat: add dark mode support
fix: resolve task list rendering issue
docs: update installation guide

Pull Request Guidelines

PR title should clearly describe the changes
Reference related Issues in the description (if any)
Ensure all CI checks pass
Wait for code review
Make changes based on feedback

Code Review

All submissions require code review. Reviewers will focus on:

Code quality and readability
Test coverage
Documentation completeness
Consistency with existing code

Development Guide

Project Structure

workany/
├── src/                    # Frontend source code
│   ├── components/         # React components
│   ├── pages/              # Page components
│   ├── db/                 # Database layer
│   ├── hooks/              # Custom hooks
│   └── providers/          # Context providers
├── src-api/                # Backend API service
├── src-tauri/              # Tauri native layer
└── scripts/                # Build scripts

Tech Stack

Frontend: React 19, TypeScript, Vite, Tailwind CSS
Backend: Hono, Claude Agent SDK
Desktop: Tauri 2, SQLite

Development Commands

# Start frontend development server
pnpm dev

# Start frontend + API service
pnpm dev:all

# Start Tauri development mode
pnpm tauri dev

# Build
pnpm build

# Type check
pnpm tsc --noEmit

Code Style

Use TypeScript for type-safe development
Use ESLint and Prettier for code consistency
Use functional components and hooks
Use meaningful variable and function names

License

By contributing to this project, you agree that:

Your contributions will be licensed under the WorkAny Community License
ThinkAny, LLC may use your contributed code for commercial purposes, including cloud services and enterprise editions
ThinkAny, LLC may adjust the open-source agreement as deemed necessary

Contact

If you have any questions, feel free to reach out:

GitHub Issues: github.com/workany-ai/workany/issues
Email: hello@workany.ai

Thank you for your contributions!