Document that org.assertj.core.api.Assertions is now directly usable
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 半日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- java
調査の方向性
まず参照されている issue 329 と pull request 330 を読み、次にこの issue からリンクされている Quick start、Concepts、Release notes の各セクションを確認します。依存関係のバージョン、見出し、本文、imports、例を更新し、AssertJ Core assertions は AssertJ DB assertions と共存でき、推奨されることを説明するとともに、古いバージョン向けの互換性に関する案内を維持します。3.0.1 と 3.0.2 の注記を追加します。
索引モデルが issue の本文から書いたものです。
説明
Hello AssertJ DB
Following https://github.com/assertj/assertj-db/issues/329 and its PR https://github.com/assertj/assertj-db/pull/330
AssertJ DB Documentation should now mention that it is now possible for both AssertJ DB and AssertJ Core assertions to coexist in the same class with only one static import from AssertJ Core.
I took a look at the documentation to find occurences of the Assertions class full name.
Here are the candidates for modification that I found :
Quick start
- Dependency management - https://assertj.github.io/doc/#assertj-db-quickstart-dependency
- Both maven and gradle part should be updated with latest version
- How to use the static import - https://assertj.github.io/doc/#statically-import-org-assertj-db-api-assertions-assertthat
- Title of the paragraph
- Content of the paragraph itself
Concepts - Navigation
- With a Table or a Request as root - https://assertj.github.io/doc/#assertj-db-concepts-tableorrequestasroot
- The introductory phrase uses Assertions class full name
- Both samples of code for Table and Request have the static import
- With Changes as root - https://assertj.github.io/doc/#assertj-db-concepts-changesasroot
- Same as above
Release notes - https://assertj.github.io/doc/#assertj-db-release-notes
- Add the 3.0.2 - and the 3.0.1 for good measure
As for how, here are my thoughts :
- Using
org.assertj.core.api.Assertions.assertThatwith previous versions of the library would not compile. So developers still using those should not have that as the only reference. So for now I believe the documentation should mention bothAssertionsclass. - However I believe the feature makes
org.assertj.db.api.Assertions.assertThatirrelevant. And I think the documentation should make it clear thatorg.assertj.core.api.Assertions.assertThatis to be favored.
If documentation is open for contribution, I am willing to do a proposal.
- 主要言語
- CSS
- スター
- 26
- フォーク
- 32
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 4
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
assertj/doc のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 52/100
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
agilepathway/label-checker#640 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
BasedHardware/omi#15662 · コメント 1 件 ·
-
documentation help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
-
documentation good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
Kong/developer.konghq.com#7316 ·