microsoft / microsoft/vscode-textmate

Missing a changelog

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

Nobody has claimed this yet.

feature-request
Dominant language
TypeScript
Stars
678
Forks
135
Avg merge
1d 14h
Merged PRs (30d)
2

Description

A VSCode extension I was developing for was recently "bitten" by the breaking changes from v3 to v4. However as there is no changelog it's extremely difficult to figure out what's happened due to quite brief commit messages.

It would be nice if there was a changelog (e.g. keepachangelog.com) to group changes together.

Contributor guide

No contributing guide indexed for this repository

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 the repository history and the changes around the v3-to-v4 transition, paying attention to the brief commit messages mentioned in the issue. Use keepachangelog.com as the suggested format; done means the project has a changelog grouping the relevant changes so extension developers can identify breaking changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
documentation
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.