Skip to content

docs: dịch README mặc định sang tiếng Anh, giữ bản tiếng Việt và thêm disclaimer - #12

Merged
WindowScary321 merged 2 commits into
mainfrom
docs/english-readme
Nov 18, 2026
Merged

WindowScary321 merged 2 commits into
mainfrom
docs/english-readme

Conversation

@WindowScary321

Copy link
Copy Markdown
Owner

Tóm tắt thay đổi

  • Dịch README.md sang tiếng Anh để làm README mặc định ở gốc repository, đồng thời trỏ liên kết trực tiếp tới bản tiếng Việt (./README.vi.md).
  • Giữ lại bản tiếng Việt tại README.vi.md với liên kết quay lại bản tiếng Anh (./README.md), giữ nguyên toàn bộ liên kết tài liệu chi tiết trong ./docs/cli/.
  • Bổ sung mục Disclaimer / Tuyên bố miễn trừ trách nhiệm rõ ràng ở cả hai bản (README.md và README.vi.md): nhấn mạnh công cụ không chính thức (unofficial), sử dụng tự chịu rủi ro (use at your own risk), cảnh báo về API nội bộ reverse-engineered, lưu trữ session JSON thuần tại ~/.myfap-api-cli/session.json, và sử dụng có trách nhiệm.
  • Cập nhật MANIFEST.in (include LICENSE, include README.md, exclude README.vi.md, global-exclude *.py[cod] __pycache__) để README.vi.md không lọt vào sdist và tiếp tục đạt scripts/check_artifacts.py.

Kiểm tra cục bộ

  • validate_copy.py README.vi.md --register eng-readme --strict: 0 lỗi, 0 cảnh báo.
  • Kiểm tra Unicode NFC, không có em-dash/en-dash trong văn bản và không có liên kết nội bộ gãy.
  • uv run --locked --group ci python -m unittest discover -s tests -v: Ran 435 tests (431 OK, 4 skipped), exit 0.
  • uv build + twine check --strict + scripts/check_artifacts.py: PASSED (manifest_sha256=d4df189b378c2d8fb38cb3c8b4f73cc921592ef5a0b916a2fa004f41d248248d), exit 0.

@WindowScary321

WindowScary321 commented Nov 18, 2026 •

Copy link
Copy Markdown
Owner Author

Đã đẩy commit d5b02998938e4ffd545f2bf01bd6999c21c92393 từ nhánh docs/english-readme (nhánh tạo mới từ origin/main tại 94ee7fe).

Kết quả kiểm tra cục bộ

  • uv run --locked --group ci python C:\Users\admin\.agents\skills\vietnamese-tech-writing\scripts\validate_copy.py README.vi.md --register eng-readme --strict: exit 0 (1 file(s) checked · 0 error(s) · 0 warning(s)).
  • Kiểm tra Unicode NFC, dấu câu (không có em-dash — / en-dash –) và liên kết tương đối trong README.md / README.vi.md: exit 0 (5/5 liên kết hợp lệ ở mỗi file).
  • git diff --check: exit 0.
  • uv run --locked --group ci python -m unittest discover -s tests -v: exit 0 (Ran 435 tests in 87.533s, OK (skipped=4) trên dữ liệu test/fixture tổng hợp).
  • uv build + python -m twine check --strict + python scripts/check_artifacts.py: exit 0 (myfap-0.2.0-py3-none-any.whl và myfap-0.2.0.tar.gz đều PASSED, manifest_sha256=d4df189b378c2d8fb38cb3c8b4f73cc921592ef5a0b916a2fa004f41d248248d).

Giới hạn & lưu ý

  • Bộ unit test sử dụng dữ liệu tổng hợp / HTTP giả; không chạy kiểm thử live với tài khoản thật.
  • Chưa chạy kiểm tra GitHub Actions trên PR này (chờ workflow CI chạy sau khi tạo PR).

@WindowScary321

WindowScary321 commented Nov 18, 2026 •

Copy link
Copy Markdown
Owner Author

Sau commit 208d3cf: thêm mục giấy phép MIT vào README

Commit: 208d3cf

Thay đổi chính

  • README.md (+4): thêm mục ## License ở cuối file, dẫn liên kết tới [LICENSE](./LICENSE) cho giấy phép MIT.
  • README.vi.md (+4): thêm mục ## Giấy phép ở cuối file, dẫn liên kết tới [LICENSE](./LICENSE) cho giấy phép MIT.

Kiểm tra đã chạy

Trên nội dung của commit 208d3cf (chỉ sửa 2 file .md):

  • uv run --locked --group ci python C:\Users\admin\.agents\skills\vietnamese-tech-writing\scripts\validate_copy.py README.vi.md --register eng-readme --strict: exit 0 (1 file(s) checked · 0 error(s) · 0 warning(s)).
  • Kiểm tra Unicode NFC, dấu câu (không có em-dash/en-dash) và liên kết tương đối trong README.md và README.vi.md: exit 0 (NFC=True, 6/6 liên kết hợp lệ ở mỗi file, bao gồm ./LICENSE).
  • git diff --check và git diff --cached --check: exit 0.

Trên nền commit d5b0299 ngay trước đó (code Python và MANIFEST.in không đổi ở 208d3cf):

  • uv run --locked --group ci python -m unittest discover -s tests -v: 435 test, 431 đạt / 4 skip, exit 0.
  • uv build + twine check --strict + scripts/check_artifacts.py: PASSED, exit 0 (manifest_sha256=d4df189b378c2d8fb38cb3c8b4f73cc921592ef5a0b916a2fa004f41d248248d).

Giới hạn

@WindowScary321 WindowScary321 self-assigned this Nov 18, 2026
@WindowScary321
WindowScary321 merged commit d7d29e4 into main Nov 18, 2026
11 checks passed
@WindowScary321
WindowScary321 deleted the docs/english-readme branch November 18, 2026 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant