layer5io / layer5io/sistent

[Docs] Clean up `CHANGELOG.md`

Open
#438 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/ci area/docs framework/jekyll language/markdown on-hold
Dominant language
TypeScript
Stars
137
Forks
239
Avg merge
4d 14h
Merged PRs (30d)
5

Description

Current State

The CHANGELOG.md have multiple commits of the same commits from the releases.

Once we move to single package repo, but still keeping in mind of any other packages that we may need as separate use case, the CHANGELOG.md needs to be updated.

Desired State

Contributor Guides and Resources

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 with CHANGELOG.md and the linked Meshery Build & Release Strategy; identify repeated release commits and determine the intended single-package versus separate-package entries. Done means CHANGELOG.md is updated consistently with that packaging approach, but the issue does not define the desired final format.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.