Problem/Motivation

Keeping a changelog is a good best practice to follow.

Proposed resolution

Use Keep a Changelog.

Because we are using mkdocs, we could probably put this file in the root of the repository and symlink it from /docs, the same way README.md is. This would allow it work with both GitLab and mkdocs.

Remaining tasks

  • Add the file to the repository root.
  • Symlink to it from the docs directory.

User interface changes

This will add a new page to the mkdocs documentation.

  • A new page will be added to the mkdocs documentation.
  • GitLab should display a CHANGELOG link on the repository homepage.

API changes

N/A

Data model changes

N/A

Issue fork member-3515995

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

alexdmccabe created an issue. See original summary.

alexdmccabe’s picture

Issue summary: View changes
alexdmccabe’s picture

Assigned: Unassigned » alexdmccabe

alexdmccabe’s picture

Issue summary: View changes
alexdmccabe’s picture

Status: Active » Needs review

This is ready for review.

mtift’s picture

Status: Needs review » Reviewed & tested by the community

Looks good to me!

jdleonard made their first commit to this issue’s fork.

jdleonard’s picture

Status: Reviewed & tested by the community » Fixed

Thanks!

jdleonard’s picture

Assigned: alexdmccabe » Unassigned

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.