Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Update documentation style

Đang mở
#96 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách đọc HOOMD-blue pull request #1952, sau đó so sánh phong cách tài liệu của nó với tài liệu hiện tại của azplugins. Xác định phạm vi của việc cập nhật phong cách; công việc hoàn tất khi tài liệu của azplugins tuân theo phong cách HOOMD đã thống nhất.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

HOOMD changed its documentation style:

https://github.com/glotzerlab/hoomd-blue/pull/1952

We should consider if we want to update azplugins to adhere to this style to make it feel part of HOOMD and make it easier to port code in future.

Ngôn ngữ chính
C++
Star
27
Fork
18
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của mphowardlab/azplugins

Tất cả issue của mphowardlab/azplugins

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.