Dynatrace / Dynatrace/backstage-plugin

Introduce Changesets for auto-generated changelogs

Open
#12 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
37
Forks
19
Avg merge
4d 11h
Merged PRs (30d)
2

Description

The repository uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), but the granularity of a commit does not sufficiently match a significant change worth documenting.

The Backstage project itself also uses conventional commits (not very consistently, though), but relies on [Changesets](https://github.com/changesets/changesets) to generate changelogs (after the first stable release).

It would be good to introduce Changesets, and include a changeset for each significant change in the code base. During pull request reviews, thes changeset can be ensured/reviewed/discussed.

Conventional commits could stay if they serve a purpose (or just for consistency).

Contributor guide

Open the contributing guide

Research direction

The issue names no files or tests; start by reviewing the repository's conventional-commit practice and the Changesets documentation. Determine how significant changes should be recorded and how changelogs should be generated and reviewed in pull requests. Done means Changesets is integrated and each significant code change has an appropriate changeset.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.