nodejs / nodejs/Release

Improving the release announcement editing/reviewing process of major releases

Open
#1,063 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
4.4k
Forks
675
Avg merge
22h 29m
Merged PRs (30d)
1

Description

In the release announcement curation process of recent major releases there have been a lot of room for improvement, so opening an issue to discuss how we can make it edited better. Specifically, what goes out in the blog post on nodejs.org, and in the summary of the change logs:

  1. We can make the release announcements reviewed more precisely by contributors using a regular PR adding a document somewhere (the website repo?), and we can do reviews on GitHub
  2. We can make some changes to the release process so that we have sufficient time to edit the release announcement, and notify authors of notable changes/semver-major changes in time for the editing process
  3. We can do some format changes to the release announcements on the blog posts to improve readability and help users grasp what's new in the release e.g. maybe remove/fold the list of commits in the posts, since people probably won't read them in a blog post and they belong more in changelogs.

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

Review recent major-release announcements on nodejs.org and their changelog summaries, then compare how contributors currently edit and review them. Define an agreed GitHub-based review process, release timing and author notification steps, and a clearer announcement format; done means the process and format changes are documented and agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
content, documentation, release
Issue type
Feature
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.