Add examples
オープン
まだ誰も着手していません。
good first issue
help wanted
- 主要言語
- Java
- スター
- 71
- フォーク
- 44
- 平均マージ
- 12時間 54分
- マージ済み PR(30日)
- 7
説明
It would help first time users to create some examples for common library usage.
Some ideas for different examples:
- Creating a document, adding a few files using the SPDX Model Factory
- Parsing license expressions using the SPDX license parser
- Comparing SPDX documents using the SPDX Document Comparer
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされている SpdxModelFactory.java、LicenseInfoFactory.java、SpdxComparer.java のエントリポイントから始めて、提案されている3つのワークフローを理解します。ドキュメントとファイルの作成、ライセンス式の解析、SPDXドキュメントの比較を行う実行可能な例を追加します。初めて利用するユーザー向けに、ライブラリの3つの一般的な使用方法がすべて明確に示されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100