Руководство по участию

Добро пожаловать в проект документации BlockTavern! Это руководство поможет вам быстро начать работу и внести качественный вклад.

Подготовка среды

Системные требования

• Node.js 18+
• Git последняя версия
• Аккаунт GitHub

Рекомендуемые инструменты разработки

• VS Code + расширение Markdown
• GitHub Desktop (опционально)

Оптимизация изображений

Перед использованием локальных изображений сжимайте размер файлов или используйте стабильные сервисы хостинга изображений для повышения скорости загрузки.

Быстрый старт

1. Форк проекта

1. Перейдите в репозиторий проекта: doc_blocktavern
2. Нажмите кнопку Fork в правом верхнем углу
3. Дождитесь завершения форка

2. Локальная разработка

# Клонируйте ваш форк
git clone https://github.com/YOUR_USERNAME/doc_blocktavern.git
cd doc_blocktavern

# Установите зависимости
npm install

# Запустите сервер разработки
npm run docs:dev

Перейдите по адресу http://localhost:5173 для предварительного просмотра сайта документации.

3. Создание ветки

# Создайте ветку функции
git checkout -b feature/your-feature-name

# Или ветку исправления
git checkout -b fix/your-fix-name

Процесс участия

1. Написание контента

• Редактируйте или создавайте документы в директории docs/zh-CN/
• Следуйте стандартам написания документации
• Предварительный просмотр в реальном времени: браузер автоматически обновляется после сохранения

2. Фиксация изменений

# Добавьте измененные файлы
git add .

# Зафиксируйте изменения (используя стандартное сообщение коммита)
git commit -m "docs: добавить описание новой функции"

# Отправьте в ваш форк
git push origin feature/your-feature-name

3. Создание Pull Request

1. Перейдите на страницу вашего форк-репозитория
2. Нажмите кнопку Compare & pull request
3. Заполните информацию о PR:
   • Заголовок: кратко опишите содержание изменений
   • Описание: подробно объясните причину и влияние изменений
4. Нажмите Create pull request

4. Ожидание рецензирования

• Сопровождающие проекта рассмотрят ваш PR
• Могут потребовать изменения или дополнения
• После одобрения рецензии изменения будут объединены с основной веткой

Стандарты коммитов

Формат сообщения коммита

<type>(<scope>): <description>

[optional body]

[optional footer]

Типы (type):

• docs: обновление документации
• feat: новая функция
• fix: исправление проблемы
• style: форматирование
• refactor: рефакторинг

Примеры:

git commit -m "docs(guide): добавить руководство по установке"
git commit -m "fix(config): исправить ошибку конфигурации боковой панели"
git commit -m "feat(search): добавить функцию поиска"

Стандарты именования веток

• feature/название-функции: разработка новой функции
• fix/описание-проблемы: исправление проблемы
• docs/тип-документации: обновление документации
• refactor/содержание-рефакторинга: рефакторинг кода

Типы участия

Участие в документации

• Добавление документации: создание новых руководств или учебных пособий
• Улучшение контента: дополнение подробной информации к существующей документации
• Исправление ошибок: исправление неточной информации в документации
• Переводческая работа: перевод китайской документации на другие языки

Техническое участие

• Оптимизация конфигурации: улучшение конфигурации VitePress
• Улучшение стилей: оптимизация стилей сайта документации
• Расширение функций: добавление новых функций документации
• Оптимизация производительности: повышение скорости загрузки сайта

Стандарты качества

Качество документации

• [ ] Содержание точное и безошибочное
• [ ] Ясное языковое выражение
• [ ] Разумная структурная иерархия
• [ ] Исполняемые примеры кода
• [ ] Действительные и доступные ссылки
• [ ] Четкие и подходящие изображения

Техническое качество

• [ ] Последовательный стиль кода
• [ ] Правильный синтаксис конфигурации
• [ ] Прохождение тестов сборки
• [ ] Хорошая совместимость

Получение помощи

Просмотр существующей документации

• Просмотрите сайт документации для получения подробной информации
• Посетите репозиторий GitHub для получения последнего кода

Отправка проблем

Если вы столкнулись с проблемами или у вас есть предложения, пожалуйста:

1. Найдите связанные проблемы в GitHub Issues
2. Если не найдено, создайте новую Issue
3. Подробно опишите проблему и шаги воспроизведения

Связь с сопровождающими

• GitHub: @BlockTavern
• Электронная почта: contact@blocktavern.com

Справочные ресурсы

• Официальная документация VitePress
• Официальная документация Vue.js
• Руководство по синтаксису Markdown

---

感谢您的贡献！每一份贡献都让 BlockTavern 文档变得更好。

# Участники

Загрузка...

# Журнал изменений

Загрузка...

Посмотреть полную историю

Загрузка...