Blame: CONTRIBUTING.md - tw93/Pake

tw93 / Pake UNCLAIMED

🤱🏻 Turn any webpage into a desktop app with one command.

0 0 1 Rust

:bug: 更新文档 2022-11-10 09:48:06 +08:00			`## How to contribute to Pake`

			`Welcome to create [pull requests](https://github.com/tw93/Pake/compare/) for bugfix, new component, doc, example, suggestion and anything.`

			`## Branch Management`

docs: simplify branch management to main-only workflow 2026-03-08 13:00:40 +08:00			All development happens directly on `main`. Submit pull requests to `main`.
:bug: 更新文档 2022-11-10 09:48:06 +08:00
:wrench: Update to the latest stable versions of node and rust 2025-08-13 16:42:58 +08:00			`## Development Setup`

			`### Prerequisites`

Most documents have been updated 2025-12-11 15:40:37 +08:00			`- Node.js ≥22.0.0 (recommended LTS, older versions ≥18.0.0 may work)`
update faq 2025-11-16 19:56:17 +08:00			`- Rust ≥1.85.0 (required for edition2024 support in dependencies)`
:wrench: Update to the latest stable versions of node and rust 2025-08-13 16:42:58 +08:00			`- Platform-specific build tools:`
			- macOS: Xcode Command Line Tools (`xcode-select --install`)
			`- Windows: Visual Studio Build Tools with MSVC`
			- Linux: `build-essential`, `libwebkit2gtk`, system dependencies

			`### Installation`

			```bash
			`# Clone the repository`
			`git clone https://github.com/tw93/Pake.git`
			`cd Pake`

			`# Install dependencies`
:sparkles: Refactoring with documentation 2025-08-28 19:35:31 +08:00			`pnpm install`
:wrench: Update to the latest stable versions of node and rust 2025-08-13 16:42:58 +08:00
feat: enhance CLI development workflow, add iterative build, and refine app naming defaults 2025-12-12 20:18:41 +08:00			`# Start development (Tauri only)`
:sparkles: Refactoring with documentation 2025-08-28 19:35:31 +08:00			`pnpm run dev`
feat: enhance CLI development workflow, add iterative build, and refine app naming defaults 2025-12-12 20:18:41 +08:00
			`# Start development (CLI Wrapper + Tauri) - Recommended for CLI changes`
			`pnpm run cli:dev -- https://web.telegram.org/k/`
:wrench: Update to the latest stable versions of node and rust 2025-08-13 16:42:58 +08:00			```

:sparkles: Increase comprehensive testing capabilities 2025-08-14 11:17:19 +08:00			`### Testing`

			```bash
			`# Run all tests (unit + integration + builder)`
:sparkles: Refactoring with documentation 2025-08-28 19:35:31 +08:00			`pnpm test`
:sparkles: Increase comprehensive testing capabilities 2025-08-14 11:17:19 +08:00
:art: format code 2025-08-14 11:20:15 +08:00			`# Build CLI for testing`
:sparkles: Refactoring with documentation 2025-08-28 19:35:31 +08:00			`pnpm run cli:build`
:sparkles: Increase comprehensive testing capabilities 2025-08-14 11:17:19 +08:00			```

feat: enhance CLI development workflow, add iterative build, and refine app naming defaults 2025-12-12 20:18:41 +08:00			`### Tips`

			- Use `--iterative-build` flag during development to skip some hefty checks and use app bundle format for faster debugging:

			```bash
			`pnpm run cli:dev --iterative-build`
			```

:sparkles: Increase comprehensive testing capabilities 2025-08-14 11:17:19 +08:00			`## Continuous Integration`

			`The project uses streamlined GitHub Actions workflows:`

			`- Quality & Testing: Automatic code quality checks and comprehensive testing on all platforms`
			`- Claude AI Integration: Automated code review and interactive assistance`
			`- Release Management: Coordinated releases with app building and Docker publishing`

:wrench: Update to the latest stable versions of node and rust 2025-08-13 16:42:58 +08:00			`## Troubleshooting`

			`### macOS 26 Beta Compilation Issues`

			If you're running macOS 26 Beta and encounter compilation errors related to `mac-notification-sys` or system frameworks (errors about `CoreFoundation`, `_Builtin_float` modules), create a `src-tauri/.cargo/config.toml` file with:

			```toml
			`[env]`
			`# Fix for macOS 26 Beta compatibility issues`
			`# Forces use of compatible SDK when building on macOS 26 Beta`
Fix cargo command not found after Rust installation 2025-10-13 19:41:28 +08:00			`MACOSX_DEPLOYMENT_TARGET = "15.0"`
			`SDKROOT = "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk"`
:wrench: Update to the latest stable versions of node and rust 2025-08-13 16:42:58 +08:00			```

			This file is already in `.gitignore` and should not be committed to the repository.

Fix cargo command not found after Rust installation 2025-10-13 19:41:28 +08:00			`Root Cause: macOS 26 Beta uses newer system frameworks that aren't yet fully compatible with Tauri's dependencies. This configuration uses the universal SDK symlink which automatically points to your system's available SDK version.`
:wrench: Update to the latest stable versions of node and rust 2025-08-13 16:42:58 +08:00
			`### Common Build Issues`

			- Rust compilation errors: Run `cargo clean` in `src-tauri/` directory
Fix cargo command not found after Rust installation 2025-10-13 19:41:28 +08:00			- `cargo` command not found after installation: Pake CLI now reloads the Rust environment automatically, but if the issue persists reopen your terminal or run `source ~/.cargo/env` (macOS/Linux) / `call %USERPROFILE%\.cargo\env` (Windows) before retrying
:sparkles: Refactoring with documentation 2025-08-28 19:35:31 +08:00			- Node dependency issues: Delete `node_modules` and run `pnpm install`
:wrench: Update to the latest stable versions of node and rust 2025-08-13 16:42:58 +08:00			- Permission errors on macOS: Run `sudo xcode-select --reset`

:sparkles: Refactoring with documentation 2025-08-28 19:35:31 +08:00			`See the [Advanced Usage Guide](docs/advanced-usage.md) for project structure and customization techniques.`

:bug: 更新文档 2022-11-10 09:48:06 +08:00			`## More`

			`It is a good habit to create a feature request issue to discuss whether the feature is necessary before you implement it. However, it's unnecessary to create an issue to claim that you found a typo or improved the readability of documentation, just create a pull request.`