[Feature Request] Refactor of the Developer Guidance.

Đang mở
  • Có gì không ổn?
#3,265 5 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
java
Lĩnh vực
documentation

Hướng nghiên cứu

Start with the linked Developer Guidance documentation, especially its “Documentation Guidelines” section, and compare the stated expectations with the practices described in this issue. The issue asks for clarification or updated guidance, but does not settle which policy should replace the current one; confirm the intended direction with maintainers before editing. Done means the guidelines accurately reflect the agreed expectations.

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

Mô tả

Is your feature request related to a problem? Please describe.
As per the completion of the #2759 , I feel like I need to query if the PR was an exception to our developer guidelines or not.

Specifically the "Documentation Guidelines" Section of the Guidence Documentation

  1. Javadoc: Add Javadoc comments to all public classes, methods, and fields.

This has simply not been done in the PR, and in fact documentation was actively removed, with the reasoning that it would be added back later. This was not done. For context, upon analyzing for missing java docs on public classes and methods in InteliJ, there is anything between 600 to 690 instances of public methods / classes that have not got javadocs.

  1. Code Comments: Add inline comments to explain complex or non-obvious code.

This is done scantly, but not in all instances. LWJGL is a complicated framework and this would have been helpful for future contribution.

Describe the solution you'd like
Clarification on if these guidelines are now optional.

Describe alternatives you've considered
If the guidelines are not being changed, then the only alternative is for us to follow the existing guidelines.

Additional context
A year and a half ago I was very comfortable in this project. We had hard set rules and we followed them. Heck I had Joe call me out and refuse a merge because I had used a single wildcard by accident.

But, regardless of reasoning, it just seems big chunks of the developer guidelines are not really followed anymore. As such, I am not going to be some holier than thou person who claims we should follow them to the letter.

Instead, I am going to be practical and suggest, as per this issue, that we simply update the guidelines to better reflect how we do things now.

Ngôn ngữ chính
Java
Star
3.1k
Fork
703
Merge trung bình
22 giờ 16 phút
Pull request đã merge (30 ngày)
27

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

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 openrocket/openrocket

Tất cả issue của openrocket/openrocket

Issue tương tự

Thêm issue về Java

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.