Contributing to MicYou Website

Thank you for your interest in contributing to MicYou Website! This guide will help you get started.

Quick Links

Resource	Link
Issue Tracker	GitHub Issues
Pull Requests	GitHub PRs
Telegram Channel	@MicYouChannel

Ways to Contribute

Report Issues

Found a bug or have a suggestion?

1. Search existing issues first
2. Create a new issue with:
   • Clear, descriptive title
   • Steps to reproduce (for bugs)
   • Expected vs actual behavior
   • Screenshots (if applicable)

Submit Changes

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

Development Setup

Requirements

Dependency	Version
Node.js	>= 22
pnpm	>= 10.32

Getting Started

# Clone your fork
git clone https://github.com/YOUR_USERNAME/Website-MicYou.git
cd Website-MicYou

# Install dependencies
pnpm install

# Start dev server
pnpm dev

Useful Commands

Command	Description
pnpm dev	Start development server
pnpm build	Build for production (includes fetch:ghdata)
pnpm preview	Preview production build
pnpm lint	Run Biome linter
pnpm format	Format code with Biome
pnpm fetch:ghdata	Fetch GitHub data (releases, stats)

Coding Standards

Branch Naming

Type	Format	Example
Feature	feature/description	feature/add-japanese-support
Fix	fix/description	fix/broken-navigation-link
Docs	docs/description	docs/update-installation-guide
Chore	chore/description	chore/update-dependencies

Commit Messages

Follow conventional commits format:

<type>: <description>

[optional body]

Types:

Type	Description
feat	New feature
fix	Bug fix
docs	Documentation changes
style	Code style changes (formatting)
refactor	Code refactoring
chore	Maintenance tasks

Examples:

feat: add Japanese language support
fix: resolve broken link in quick-start.md
docs: update FAQ with new troubleshooting steps

Code Style

• Use TypeScript for configuration files
• Follow Biome formatting rules
• Keep components focused and small
• Use Vue 3 Composition API

Git Hooks

The project uses Husky for git hooks:

• pre-commit: Runs lint-staged to format staged files automatically
• No additional action required from contributors

Documentation Guidelines

Adding New Pages

1. Create the page in all supported languages:

src/docs/new-page.md          # Chinese (default)
src/en/docs/new-page.md       # English
src/zh-TW/docs/new-page.md    # Traditional Chinese

2. Update src/docs/sidebar.ts:

const sidebarTranslations = {
  'zh-CN': { /* add translation */ },
  'en': { /* add translation */ },
  'zh-TW': { /* add translation */ }
}

Markdown Guidelines

• Use proper heading hierarchy (h1 -> h2 -> h3)
• Include language in code blocks
• Keep lines under 100 characters
• Use relative links for internal references

```bash
pnpm install

### Frontmatter Requirements

All documentation pages **must** include frontmatter at the beginning:

```markdown
---
title: Page Title - Site Name
description: Brief description of the page content for SEO and social sharing.
---

# Page Title

Content...

Required fields:

Field	Description	Example
title	Page title with site name	Quick Start - MicYou Installation Guide
description	SEO description (150-160 characters recommended)	MicYou quick start guide with detailed installation and configuration instructions.

Image Guidelines

• Do not use external image links (e.g., GitHub issue attachments, external URLs)
• Place all images in src/public/ folder
• Reference images using root-relative paths: ![Description](/image-name.png)
• Use descriptive file names (e.g., input-device.png, output-device.png)
• Supported formats: PNG, JPG, SVG, WebP, GIF

Translation Guidelines

• Maintain consistent terminology across languages
• Keep translations natural, not literal
• Update all languages simultaneously
• Check .vitepress/data/lang/ for UI translations

Pull Request Process

Before Submitting

• Code builds without errors (pnpm build)
• All languages updated (if applicable)
• Commit messages follow conventions
• Branch is up to date with main

PR Template

## Description
Brief description of changes

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Refactoring

## Checklist
- [ ] Tested locally
- [ ] Updated all language versions
- [ ] Updated sidebar config (if needed)

## Related Issues
Fixes #123

Review Process

1. Maintainers will review your PR
2. Address any feedback
3. Once approved, it will be merged

Need Help?

• Open an issue for questions
• Join our Telegram for discussions

---

Thank you for contributing!