rust-lang / rust-lang/rustup

Decide on a better strategy for release notes/changelogs

Open
#3,784 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement meta
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
22h 40m
Merged PRs (30d)
46

Description

Currently, we're generating changelogs with a Python script. This is trying to mimic the exact format that rustup posts on the Rust blog have been in the past, but it would be nice to simplify this approach.

See more discussion in https://github.com/rust-lang/rustup/pull/3773#discussion_r1576087894.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the Python script that currently generates changelogs and the discussion in rustup#3773 linked from this issue. Decide on a simpler release-notes strategy and document the resulting approach; done means the project has agreement on how changelogs should be generated.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
documentation, release
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.