nodejs / nodejs/docker-node

Create CHANGELOG.md

Open
#1,201 1 comment 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Dockerfile
Stars
8.6k
Forks
2k
Avg merge
10h 19m
Merged PRs (30d)
16

Description

Even though there's an understanding that we currently see node majors as possibilities to make breaking changes to the images, recent patch updates have included breaking changes. A changelog would help communicate potential issues.

Inspired by https://github.com/nodejs/docker-node/pull/1182#issuecomment-573029445.

Refs: https://github.com/nodejs/docker-node/issues/1185
Refs: https://github.com/nodejs/docker-node/issues/1200

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

No target file, format, or test is specified. Start by reviewing the linked issues 1185 and 1200, the referenced discussion, and the repository's existing release history; done means adding a CHANGELOG.md that clearly communicates breaking changes, including those that can occur in patch updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, node.js
Domain
documentation, release
Issue type
Documentation
Difficulty
2/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.