python / python/docs-community
Cut the whale of the changelog into manageable pieces?
まだ誰も着手していません。
- 主要言語
- Makefile
- スター
- 55
- フォーク
- 26
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
The changelog page is very long:
It's currently 219,974 words, that's longer than Moby Dick (212,794 words)... 🐳
It contains all the NEWS entries back to Python 3.5.0 alpha 1 (February 8, 2015).
It loads okay on deskstop, but my phone struggles to render it, and the browser hangs when trying to search for text.
I tried to check the accessibility report using Google's PageSpeed Insights:
It shows good initial numbers:
But the rest of the report is missing: "Oops! Something went wrong. generic::deadline_exceeded: Render timeout received in extension."
Shall we break the changelog page into smaller, more manageable chunks?
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
https://docs.python.org/dev/whatsnew/changelog.html の changelog ページから始め、そこにある NEWS エントリがどのように組み立てられ、公開されているかを調査します。changelog の履歴を保持しながら、モバイルでの表示、ブラウザー検索、アクセシビリティを改善する chunking の方針を定義し、その結果のページをモバイルパフォーマンスのチェックで検証します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100