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

Aberta
  • Algo errado?
#507 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
52/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
python, rust
Domínio
desktop, documentation, testing

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Rust
Estrelas
6
Forks
2
Merge médio
1d 3h
PRs com merge (30d)
42

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de elastos/elastos-runtime

Todas as issues de elastos/elastos-runtime

Issues semelhantes

Mais issues de Rust

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.