void-linux / void-linux/void-docs

Unify `xbps/repositories/signing.md` with `void-packages/README.md`?

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

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

主要言語
CSS
スター
217
フォーク
212
平均マージ
2日 21時間
マージ済み PR(30日)
1

説明

https://github.com/void-linux/void-docs/pull/641 made me wonder if it's better to drop the section Signing Repositories and link to the README instead. Alternatively, drop the section in the README and link to the docs. Goal: not having duplicate documentation, which will probably lead to divergence in the future again.

But both "solutions" would make one document less self-contained... I don't really like either of them. But right now the README seems more of a "start to finish" guide without many links, so it's probably better to link from the docs to the README?

Another wild idea: Include the whole README into the docs, somewhere below 4. XBPS Package Manager. Not sure if that makes sense...

Maybe I'm just overthinking.

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

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

はじめの一歩

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

調査の方向性

xbps/repositories/signing.md と void-packages/README.md を比較し、関連するドキュメント変更について void-linux/void-docs#641 を確認してください。署名に関するガイダンスをどの単一のソースに含めるべきかを決定し、その後、結果として得られるドキュメントに重複したセクションがなく、読者にとって理解しやすい状態になっていることを確認してください。

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

評価

領域
documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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