Skip to content

Remove changelog from the top of the of the readme #6

@dmrickey

Description

@dmrickey

This is obviously my own opinion, but as someone that also browses modules, having the changelog at the top of the description is awful. Sometimes there are pages of changelogs that I have to scroll through before getting to the description for a mod even is. The changelog should not go above the description because the description is an elevator pitch. If I have to take a flight of stairs before I can get to a description, if those stairs are too big I'm going to just ditch the trip to the top entirely.

Having the changelog at the top makes the readme look unorganized. If the readme is too long and makes it harder to find the description for what the mod does then I just hit the back button and keep browsing through other mods that have hopefully presented themselves better.

Anyone actively looking for a changelog will be able to find one. Anyone that isn't looking for a changelog will be put off by it being the first thing presented when trying to find what the mod actually does.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions