objectbox / objectbox/objectbox-java

API cleanup

オープン
#406 コメント 2 件 リアクション 3 件 担当者 0 名 GitHub で見る

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

low priority
主要言語
Java
スター
4.6k
フォーク
311
PR マージ指標
30日以内にマージされた PR はありません

説明

Good evening,

I think it would be productive to clean up the API around the library a bit.

There are for example numerous methods/variables that are rather confusing (e.g. box.panicModeRemoveAll() and box.all2), and quite a few calls include "internal" in their names even though they are public. Is there a reason for this?

Its not the end of the world, but I do think it would make a difference - and one of the things I appreciated with Realm earlier on was how everything had its place. You could never see any of its implementation details, and you could fully focus on creating awesome stuff.

Thanks!
Zoltan

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

調査の方向性

ファイルやテストは指定されていません。まず公開 API シンボル box.panicModeRemoveAll()box.all2、および internal を含むメソッドを探し、次にライブラリがそれらをどのように公開しているかを確認してください。完了とするには、整理の範囲について合意し、影響を受ける API 全体で一貫した公開名にする必要があります。

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

評価

技術スタック
java
領域
api
issue の種類
リファクタリング
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
20/100

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

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