Cách đóng góp

Ai cũng có thể góp thêm vào wiki này. Mỗi hướng dẫn là một file văn bản lưu trên GitHub, một website miễn phí nơi mọi người cùng nhau làm việc trên các file. Bạn đề xuất một thay đổi. Một người bảo trì kiểm tra rồi đăng nó.

Trước khi bắt đầu

Bạn cần một tài khoản GitHub miễn phí. Tạo một cái ở github.com/signup. Đó là toàn bộ khâu chuẩn bị.

Ba từ bạn sẽ gặp rất nhiều:

• Fork là bản sao riêng của bạn cho các file của wiki trên GitHub.
• Commit là một thay đổi đã được lưu vào các file đó.
• Pull request (hay PR) là lời đề nghị người bảo trì đăng thay đổi của bạn.

Viết một hướng dẫn mới

Wiki có trình chỉnh sửa trực quan. Bạn viết trong trình duyệt và xem bản xem trước ngay lập tức. Không tải gì, không code.

1. Nhấn Contribute trên thanh trên cùng. Một cửa sổ với hai lựa chọn mở ra.
2. Chọn Visual editor. Trình chỉnh sửa mở ra.
3. Điền Title, Category và Description.
4. Viết hướng dẫn của bạn ở bên trái. Bên phải cho thấy trang đã đăng sẽ trông ra sao.

Sẵn sàng gửi đi chưa?

5. Nhấn Contribute ở góc trên bên phải.

6. Trình chỉnh sửa có thể gợi ý các liên kết tới hướng dẫn khác mà nó tìm thấy trong văn bản của bạn. Nhấn những cái bạn muốn, rồi nhấn Continue to GitHub.

7. Cửa sổ Publish your guide mở ra. Nó có ba bước. Giữ tab này mở tới khi bạn xong.

8. Gõ tên người dùng GitHub của bạn vào ô. Các nút bên dưới dùng nó để tìm fork của bạn.

9. Nhấn Fork on GitHub. GitHub mở trang Create a new fork. Nhấn nút Create fork màu xanh. Việc này tạo bản sao wiki của riêng bạn. Bạn chỉ làm một lần. Đã có fork rồi? Bỏ qua bước này.

   

10. Quay lại tab wiki. Nhấn Create the file on GitHub.

    

11. GitHub mở một file mới trên fork của bạn với hướng dẫn đã điền sẵn. Kiểm tra tên file và văn bản. Rồi nhấn nút Commit changes... màu xanh ở góc trên bên phải.

    

12. Một cửa sổ nhỏ mở ra. Giữ lựa chọn đầu tiên, Commit directly to the main branch. Nhấn Commit changes.

    

13. Quay lại tab wiki. Nhấn Open the pull request on GitHub.

    

14. GitHub hiện các thay đổi của bạn và một biểu mẫu. Điền vào biểu mẫu. Để nguyên Allow edits by maintainers đã tick. Nhấn Create pull request.

    

Xong rồi. Một người bảo trì duyệt hướng dẫn của bạn và đăng nó. Hướng dẫn của bạn có dùng hình ảnh không? Còn một bước nữa: xem Thêm hình ảnh bên dưới.

Chỉnh sửa một hướng dẫn có sẵn

1. Mở hướng dẫn bạn muốn thay đổi.
2. Cuộn xuống dưới cùng. Nhấn Edit on GitHub. Trình chỉnh sửa trực quan mở ra với hướng dẫn đã nạp sẵn.
3. Chỉnh sửa của bạn.
4. Nhấn Contribute.
5. Nhấn Copy MDX. GitHub không điền sẵn được bản chỉnh, nên bạn tự dán vào.
6. Nhấn Open guide on GitHub.
7. Nhấn biểu tượng bút chì ở góc trên bên phải của file.
8. Chọn hết văn bản cũ. Dán bản sao của bạn đè lên.
9. Nhấn Commit changes..., rồi Propose changes, rồi Create pull request.

Thêm hình ảnh

Trong trình chỉnh sửa, nhấn Upload image để đưa một tấm ảnh vào hướng dẫn của bạn. Ảnh hiện ngay trong bản xem trước. Nhưng file ảnh không đi cùng văn bản lên GitHub. Bạn tự tải nó lên, sau khi commit hướng dẫn.

Tải ảnh lên sau khi bạn commit

Khi bản nháp của bạn dùng ảnh, cửa sổ Contribute liệt kê đúng những tên file cần tải lên. Giữ danh sách đó bên cạnh.

1. Commit hướng dẫn của bạn trước (các bước ở trên), để pull request của bạn tồn tại.
2. Quay lại tab wiki. Trong cửa sổ Contribute, nhấn Upload on GitHub. Thư mục ảnh của fork của bạn mở ra.
3. Kéo ảnh của bạn vào. Giữ tên file y hệt như hướng dẫn của bạn dùng.
4. Nhấn Commit changes. Giữ lựa chọn đầu tiên, commit vào main.

Ảnh sẽ tự nhập vào pull request của bạn. Chúng hiện trên wiki khi pull request của bạn được merge.

Quy tắc về hình ảnh

• Dùng tên file chữ thường có gạch nối: my-screenshot.png, không phải My Screenshot.png.
• Cho mỗi ảnh một dòng alt text mô tả nó. Người duyệt sẽ kiểm tra.
• Giữ mỗi file dưới 500 KB. File lớn hơn làm trang chậm đi.
• Dùng PNG cho ảnh chụp màn hình, JPG cho ảnh thường. WebP cũng được.

Chuyện gì xảy ra sau khi bạn mở một pull request

1. Một liên kết xem trước xuất hiện dưới dạng bình luận trên pull request của bạn. Mở nó để xem thay đổi của bạn trực tiếp.
2. Một người bảo trì duyệt văn bản, liên kết và hình ảnh của bạn. Họ có thể yêu cầu vài chỉnh sửa nhỏ.
3. Khi được duyệt, thay đổi của bạn được merge. Nó lên sóng trên wiki trong vài phút.

Làm việc trên máy của bạn (nâng cao)

Với các danh mục mới, viết lại lớn, hoặc nhiều file cùng lúc, hãy làm việc trên máy của bạn. Bạn cần Node 22+, Git và một trình soạn thảo code.

git clone https://github.com/<your-username>/divine-wiki.git
cd divine-wiki
npm install
npm run dev

Fork repo ở github.com/DivineSkins/divine-wiki trước, rồi clone fork của bạn. Mở http://localhost:3000 để kiểm tra trang có tải được không. Tạo một branch, chỉnh các file dưới content/docs/en/lol/, thả ảnh vào public/wiki-images/, rồi push và mở một pull request tới main.

Cần trợ giúp?

• Kẹt với GitHub hay trình chỉnh sửa? Hỏi ở #wiki-feedback trên Discord.
• Đang lên kế hoạch cho một thay đổi lớn, như một danh mục mới hay tái cấu trúc? Đăng ở #wiki-proposals trước. Nó giúp bạn khỏi làm công việc rồi bị từ chối.