0.8.1: readable release notes in System (Update section, rendering, notes rules as a check)

オープン
  • 何か問題がありますか？
#507 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
52/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python, rust
領域
desktop, documentation, testing

調査の方向性

Start with capsules/system/browser/system.js to trace how the About section renders the update offer, then inspect scripts/release-platform-input-test.py and its existing size test. The work also requires moving the offer into an Update section and adding checks for the listed release-note rules. Done means the Update section renders readable notes and the checks reject violations, including a release heading with an allowed date.

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

説明

Found 29 Oct while preparing 0.8.0. Anders: notes stay as they are for 0.8.0; this is 0.8.1 work.

1. System > About shows release notes as raw text. The update offer is drawn by the installed System (capsules/system/browser/system.js, the update-changes field): bullets become plain lines joined by newlines in a pre-wrap paragraph, the Security/Added/Changed/Fixed headings are lost, and Markdown (backticks, bold) shows as raw characters. Because the installed System draws the offer, a fix reaches users with the update after the one that ships it.

2. Update as its own section in System. Move the update offer, its notes and the update action out of About into an Update section.

3. Release-notes rules as a check, not a guide. Add these to scripts/release-platform-input-test.py next to the existing size test, so the notes test fails instead of relying on a reviewer:

    1. Size: at most 32 bullets, each at most 500 UTF-8 bytes, at most 8192 bytes in total (continuation lines joined).
    1. Plain text only: no backtick, "**", "text", HTML tag, arrow (U+2192), em dash (U+2014), en dash (U+2013), " -- " or curly quote (U+2018, U+2019, U+201C, U+201D); menu paths use " > ".
    1. Banned words, case-insensitive whole words: now, seamless, seamlessly, easily, simply, robust, additionally, crucial, enhance, leverage, ensure, ensures.
    1. Banned internal terms: capsule, gateway, principal, sidecar, endpoint, Origin header, TLS, .rs, .py, .js, Cargo.
    1. An issue reference (#N) appears only in a bullet that states a limit: the bullet contains "Known issue", "not", "cannot", "can't" or "still".
    1. Each bullet stands alone on one line, because System shows bullets without their heading: it starts with a capital letter and ends with ".".
    1. The section heading reads "## [X.Y.Z] - YYYY-MM-DD" and its date is not earlier than any older section's date.

A humanized rewrite of the 0.8.0 notes that passes these rules and the size test was drafted (32 bullets, 8177 B, plain text); use it as the model for 0.8.1's notes.

主要言語
Rust
スター
6
フォーク
2
平均マージ
1日 3時間
マージ済み PR（30日）
42

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

elastos/elastos-runtime のほかの issue

elastos/elastos-runtime の issue をすべて見る

似ている issue

Rust の issue をもっと見る

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

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