Contribution Guide

Thank you for contributing to TextGO. This guide explains how to get involved.

Ways to Contribute

• 🐛 Report Bugs: Submit an issue when you find a problem
• 💡 Suggest Features: Share your ideas and feature requests
• 📝 Improve Documentation: Refine guides and examples
• 🔧 Fix Issues: Submit pull requests that fix bugs
• ✨ Add Features: Develop new features
• 🌍 Help Translate: Translate the interface and documentation
• 📚 Share Scripts: Share custom scripts and regular expressions

Submit an Issue

Search existing issues before submitting to avoid duplicates. When creating an issue, choose the appropriate template and provide the requested information.

Submit a Pull Request

1. Prepare Development Environment

Required tools: Node.js, pnpm, Rust, Git

# After forking the project, clone your repository
git clone https://github.com/YOUR_USERNAME/TextGO.git
cd TextGO
git remote add upstream https://github.com/C5H12O5/TextGO.git

# Install dependencies
pnpm install

2. Development and Testing

# Start development server
pnpm tauri dev

# Enable debug logs (macOS/Linux)
RUST_LOG=debug pnpm tauri dev

# Enable debug logs (Windows PowerShell)
$env:RUST_LOG="debug"; pnpm tauri dev

# Build production version
pnpm tauri build

3. Create Branch and Develop

# Update and create feature branch
git checkout main
git pull upstream main
git checkout -b feature/my-new-feature  # or fix/bug-description

Code standards:

• Frontend: Run pnpm check and pnpm lint
• Rust: Run cargo fmt --manifest-path ./src-tauri/Cargo.toml and cargo clippy --manifest-path ./src-tauri/Cargo.toml -- -D warnings

4. Commit Changes

Follow the Conventional Commits specification:

git add .
git commit -m "feat: add keyboard shortcut customization"
# or fix/docs/refactor/perf/test/chore, etc.

5. Submit Pull Request

# Push to your repository
git push origin feature/my-new-feature

Create a pull request on GitHub. Describe what changed and why, and reference related issues.

Documentation Contribution

The documentation is maintained in the TextGO Hub repository. Fork and clone that repository before making the changes below.

Improve Existing Documentation

1. Find errors or unclear parts
2. Edit the corresponding .md file
3. Submit a pull request

Translate Documentation to Other Languages

1. Copy the English documentation to a new language directory
2. Translate content
3. Keep structure consistent
4. Submit a pull request