# Đóng góp trang hướng dẫn này

Xin lưu ý: Đây là trang cẩm nang hướng dẫn được xây dựng và duy trì bởi cộng đồng Hackintosh, hoàn toàn không phải là tài liệu chính thức từ đội ngũ Acidanthera. Làm ơn đừng làm phiền hay gửi các câu hỏi liên quan đến bộ hướng dẫn này cho các thành viên của Acidanthera. Bản dịch tiếng Việt được thực hiện bởi tác giả Bảo Khánh (opens new window)

Bạn muốn đóng góp trang hướng dẫn này? Vậy thì tuyệt vời quá, dưới đây là những cách để bạn có thể giúp sức!

Lưu ý: Đối với những bạn muốn đóng góp, mình thực sự rất trân trọng tấm lòng của các bạn nhưng tụi mình là một tổ chức phi lợi nhuận (non-profit organization). Mình lập ra trang hướng dẫn này với mục đích là hướng dẫn và chia sẻ kiến thức mới chứ không phải để kiếm tiền. Nếu bạn có tài chính dư dả một chút, mình thực sự khuyên bạn nên quyên góp số tiền đó cho một tổ chức từ thiện. Crohn's and Colitis Canada (opens new window) là một tổ chức mình gợi ý nếu bạn chưa có lựa chọn nào trong đầu.

# Đóng góp thông qua Báo cáo vấn đề (Contributing via Issues)

Đóng góp qua Issues (Báo cáo vấn đề) khá đơn giản nhưng có một số quy tắc sau:

  • Hãy giữ cho tab Issues chỉ dành riêng để báo lỗi nội dung bài viết, không phải địa điểm để hỏi đáp lỗi hackintosh cá nhân. Đừng biến nơi này thành diễn đàn thảo luận lỗi cài đặt của riêng mình nhé.
  • Nếu thấy lỗi đánh máy (typo) hay chỗ nào diễn đạt khó hiểu, vui lòng chỉ rõ nó nằm ở trang nào. Tụi mình sẽ rất biết ơn nếu không phải đi "truy tìm kho báu" để xem những lỗi này nằm ở đâu.

Bạn có thể báo cáo lỗi tại đây: Báo cáo lỗi trang Getting Started With ACPI (Khởi đầu với ACPI) (opens new window)

# Đóng góp thông qua PRs (Contributing via PRs)

Một vài nguyên tắc khi đóng góp qua PRs (Pull Requests - Yêu cầu thay đổi mã nguồn):

  • Suy nghĩ cho kỹ trước khi muốn làm một điều gì đó (làm ơn đi mà).
  • Đọc kỹ lại (Proofread) những gì bạn gửi.
  • Tụi mình có quyền từ chối nếu thấy nội dung không phù hợp hoặc có thông tin không chính xác. Đương nhiên là tụi mình sẽ cho bạn biết lý do tại sao nội dung của bạn bị từ chối hoặc yêu cầu bạn sửa đổi.
    • Mình cũng đánh giá cao việc đính kèm nguồn (sources) cho bất kỳ thay đổi lớn (commits) nào để dễ dàng xác minh thông tin bạn cung cấp là hợp lệ.
  • Hình ảnh phải được lưu trữ trực tiếp trong kho lưu trữ (repo) dưới thư mục ../images/
  • PR của bạn phải được vượt qua trình kiểm tra định dạng (markdown lint) và phải sửa hết tất cả các lỗi.
  • Nói chung là, cố gắng tránh sử dụng các công cụ "không phải của Acidanthera" (non-Acidanthera tools) nếu có thể. Thông thường, mình luôn muốn tránh sử dụng các công cụ của bên thứ ba - tuy nhiên, nếu không còn cách nào khác, bạn có thể đính kèm liên kết.
    • Tuy nhiên các công cụ bị cấm (banned) hoàn toàn bao gồm:
      • UniBeast, MultiBeast và KextBeast
      • TransMac
        • Nổi tiếng là chuyên gia tạo ra các bộ cài USB phế vật (borked), lỗi tùm lum.
      • Các bộ cài từ Niresh
        • Chúng mình muốn tránh các vấn đề vi phạm bản quyền (piracy) trong các bản hướng dẫn của mình.

# Cách thức đóng góp

Cách tốt nhất để kiểm tra các thay đổi (commit) của bạn và đảm bảo chúng được định dạng đúng là tải về nodejsyarn, sau đó cài đặt công cụ VuePress và công cụ markdownlint-cli (opens new window). Khi bạn chạy lệnh yarn dev, nó sẽ tạo ra một máy chủ web nội bộ để bạn có thể xem trước những sửa đổi mình vừa thực hiện. Lệnh markdownlint * sẽ báo cho bạn biết nếu có lỗi định dạng và markdownlint -f * sẽ cố gắng tự động sửa mấy lỗi đó cho bạn.

  • Tạo ra bản sao mới từ kho lưu trữ (Fork this repo) (opens new window)
  • Cài đặt các công cụ cần thiết:
    • brew install yarn
    • npm install -g markdownlint-cli
  • Chỉnh sửa những cái bạn muốn.
  • Xây dựng trang web:
    • yarn install (Để cài đặt tất cả các plugin cần thiết)
    • yarn dev (Chạy thử trang web)
      • Bạn có thể chạy thử tại địa chỉ http://localhost:8080
  • Kiểm tra định dạng (linting) và chính tả (spellcheck):
    • markdownlint -f * (để chạy các bài kiểm tra riêng lẻ)

# Mẹo (Tips)

Một số công cụ giúp việc đóng góp trở nên dễ dàng hơn: