nodejs / nodejs/Release

Create guide on "What to do when a release is broken?"

Open
#558 1 comment 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

Related to #535, we should create a guide that covers what we should do when a release is broken.

Covering items such as:

  • Communication strategy
  • Reversion of commits in master/LTS

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 reviewing related issue #535 and the requested release-recovery topics. Draft a guide covering communication strategy and reverting commits in master/LTS; it is done when both topics are clearly documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.