[Feature Request] Refactor of the Developer Guidance.

オープン
  • 何か問題がありますか？
#3,265 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
55/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
java
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Java
スター
3.1k
フォーク
703
平均マージ
23時間 5分
マージ済み PR（30日）
27

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

openrocket/openrocket のほかの issue

openrocket/openrocket の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。