Skip to main content
Cảm ơn bạn quan tâm đến video-automator-skills. Tài liệu này tóm tắt các cách đóng góp.
Bản root CONTRIBUTING.md là nguồn chính được GitHub auto-detect. Trang này là phiên bản Mintlify với MDX components để dễ đọc hơn.

​
Báo bug

Mở GitHub Issue

Cung cấp đủ context để reproduce.
Template recommended: 
**OS + version**: macOS 14.5 / Windows 11 / Ubuntu 22.04
**Python version**: 3.12.1
**Lệnh đã chạy**: `.venv/bin/python -m tools.asset_index.watcher --scan-on-start`
**Output lỗi**:
\`\`\`
<paste full traceback>
\`\`\`
**state.json**:
\`\`\`json
<paste .asset_index/state.json nếu liên quan>
\`\`\`
**Bước reproduce**:
1. ...
2. ...

​
Đề xuất feature

Mở Issue với label feature-request:
  • Use case — bạn đang làm gì, gặp khó khăn gì.
  • Đề xuất giải pháp (nếu có).
  • Skill nào bị ảnh hưởng.

​
Quy trình PR

1

Fork + branch

Fork repo trên GitHub, clone về máy:
git clone git@github.com:<your-username>/video-automator-skills.git
cd video-automator-skills
git checkout -b feat/<short-name>
Naming convention:
  • feat/<name> — feature mới.
  • fix/<name> — bug fix.
  • docs/<name> — chỉ docs.
  • refactor/<name> — không đổi behavior.
2

Commit theo Conventional Commits

Format: <type>(<scope>): <description> (tiếng Anh).Ví dụ:
feat(asset-index): add audio resample analyzer
fix(watcher): handle FSEvents on case-insensitive volumes
docs(skills): port audio-deduplicate to MDX
Reference: conventionalcommits.org.
3

Test trước khi PR

Trên máy chưa cài (hoặc xoá .venv + .asset_index):
bash setup/Install.command
Hoàn thành end-to-end mới merge.
cd docs
mint dev
Mở http://localhost:3000, click vào trang đã sửa để verify.
4

Mở PR

Trên GitHub, mở PR về main. Mô tả gồm:
  • Vấn đề giải quyết — link Issue nếu có.
  • Thay đổi chính — bullets ngắn.
  • Cách test — checklist bạn đã chạy.
  • Screenshot — nếu đụng UI/docs.

​
Code style

  • Dùng ruff (cấu hình mặc định).
  • 4 spaces, không tab.
  • Type hints khi có thể (def f(x: int) -> str:).
  • Docstring cho function public (Google style hoặc một dòng tóm tắt).
  • Không commit print() debug — dùng logging.
  • 1 ý / câu — sentence case heading (## Bước tiếp theo, không ## BƯỚC TIẾP THEO).
  • Dùng MDX components khi cần: <Note>, <Tip>, <Warning>, <Steps>, <AccordionGroup>, <Card>, <Columns>.
  • Code block luôn có language tag (```bash, ```python, ```toml).
  • Frontmatter bắt buộc: title, description, icon.
  • Nội dung docs / UX: tiếng Việt.
  • Comment code: tiếng Anh.
  • Commit message + PR title: tiếng Anh (Conventional Commits).
  • Thuật ngữ kỹ thuật: giữ nguyên tiếng Anh — watcher, embedding, idempotent, pipeline, fork, branch, commit, PR, Issue, API key, env, venv, repo, OpenAI, Gemini, OS, CLI, MDX, frontmatter, analyzer, router.

​
Đóng góp skill mới

1

Copy template

cp -r skills/_shared skills/<your-skill>
Cập nhật <your-skill>/SKILL.md với frontmatter:
---
name: your-skill
description: <1 dòng mô tả ngắn để Cursor index>
metadata:
  short-description: <thậm chí ngắn hơn>
---
2

Viết SKILL.md đầy đủ

Theo format hiện có (xem audio-deduplicate/SKILL.md):
  • TL;DR
  • Quy tắc cứng
  • Tổng quan pipeline (bảng bước)
  • Mỗi bước: lệnh + ví dụ + cổng thoát
  • Khắc phục sự cố
3

Update AGENTS.md

Thêm dòng $your-skill vào section Project Skills trong AGENTS.md.
4

Tạo trang Mintlify

docs/skills/your-skill.mdx — port nội dung SKILL.md sang MDX. Giữ nguyên nội dung kỹ thuật, đổi format thành MDX components.Thêm vào docs/docs.json trong group Skills:
{
  "group": "Skills",
  "pages": [
    "skills/audio-deduplicate",
    "skills/your-skill"
  ]
}
5

Test trong job dummy

mkdir -p jobs/test-your-skill/input
# ...test workflow...

​
Code of Conduct

Trong mọi tương tác (Issue, PR, discussion). Phê bình mang tính xây dựng, không công kích cá nhân.
Không quảng cáo sản phẩm, không đăng nội dung độc hại, không spam comment.
Không chia sẻ API key, secret, hoặc dữ liệu cá nhân của người khác trong Issue/PR. Nếu thấy lộ key trong code → tag maintainer ngay.

​
License của contribution

Đóng góp vào repo này được xem như đồng ý cấp quyền cho bachdyon theo PolyForm Noncommercial 1.0.0 (xem LICENSE). Nếu contribution của bạn có ý định thương mại hoặc cần điều khoản license khác, vui lòng thoả thuận với tác giả trước.

​
Liên hệ

GitHub Issues

Cách chính để báo bug + đề xuất.

@bachdyon

DM tác giả nếu cần hỗ trợ về license hoặc business inquiry.