Skip to content
This repository has been archived by the owner on May 9, 2024. It is now read-only.

Backfill references in CHANGELOGs #369

Open
10 of 14 tasks
ericcornelissen opened this issue Sep 10, 2022 · 0 comments
Open
10 of 14 tasks

Backfill references in CHANGELOGs #369

ericcornelissen opened this issue Sep 10, 2022 · 0 comments
Labels
good first issue Good for newcomers meta Relates to project configuration

Comments

@ericcornelissen
Copy link
Owner

ericcornelissen commented Sep 10, 2022

Chore

Description

Recent entries to CHANGELOGs include a link reference to a Pull Request or commit that implemented that particular change. This practice wasn't there historically, so some CHANGELOGs do not include a reference for all changes. For consistency, we want to have a reference for all changes in every CHANGELOG.

Notes

  1. A reference must be either a to a Pull Request (e.g. ([#314]), or see this CHANGELOG.md) or to a commit (e.g. ([6175995]), or see this CHANGELOG.md).
  2. If you want to contribute to this issue, please leave a comment with the name of the package of which you plan to backfill the CHANGELOG.
  3. The backfilling of the CHANGELOG does not receive an entry in the CHANGELOG.
  4. Occasionally we will incorporate the backfilling of a CHANGELOG with the release of the respective package. There will be an indication when this is happening in the issue description.

Progress


As this issue concerns all package, the labels of individual packages won't be added.

@ericcornelissen ericcornelissen added the meta Relates to project configuration label Sep 10, 2022
@ericcornelissen ericcornelissen added the good first issue Good for newcomers label Sep 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers meta Relates to project configuration
Projects
None yet
Development

No branches or pull requests

1 participant