libgit2 / libgit2/www.libgit2.org

Reference documentation for types is a bit odd

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

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

主要言語
CSS
スター
116
フォーク
67
PR マージ指標
30日以内にマージされた PR はありません

説明

There are a few examples where we expose the type details in sys but also have it opaque in the regular public docs. For example, git_credential_username.

In these cases, we don't provide any information about the type in the standard credential docs, only in sys. We should do better.

I would expect to see something here: https://libgit2.org/docs/reference/main/credential/index.html

Instead, I only see it here: https://libgit2.org/docs/reference/main/sys/credential/index.html

When we fix this, we need to update the redirects in libgit2.org/libgit2/index.html to account for it

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

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

はじめの一歩

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

調査の方向性

libgit2.org/docs/reference/main/credential/index.html の標準 credential リファレンスと sys リファレンスを、git_credential_username を例として比較します。次に libgit2.org/libgit2/index.html を調べ、リファレンスドキュメントと併せてリダイレクトを更新します。関連する型情報が通常の credential ドキュメントに現れ、リダイレクトが変更を反映していれば完了です。

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

評価

領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

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

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