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

Ouverte
  • Quelque chose ne va pas ?
#507 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
52/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
python, rust
Domaine
desktop, documentation, testing

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Rust
Étoiles
6
Forks
2
Merge moyen
1 j 3 h
PR mergées (30 j)
42

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de elastos/elastos-runtime

Toutes les issues de elastos/elastos-runtime

Issues similaires

Plus d'issues Rust

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.