Skip to content

Improve formatting for single contributor in release #9

@PaulRBerg

Description

@PaulRBerg

I like Common Changelog a lot, but the format is a bit repetitive when all the references are authored by a single contributor. Here's an example from one of my open-source projects PRBTest:

Screenshot 2022-12-06 at 12 36 16 PM

It would be nice if the Common Changelog standard suggested a way to reference a contributor only once when appropriate, potentially underneath the release title or underneath each category:

## v0.2.0

All of the contributions below have been made by @paulrberg.

Or:

## v0.2.0

### Changed

All of the contributions below have been made authored by @paulrberg.

- Set cheatcode mutability/ visibility
- Split `Vm` in `Vm` and `VmSafe` interfaces

I know that the current standard recommends that:

If the project only has one contributor, author names can be omitted.

But there can be the situation (in fact, I would argue that this is the most common situation) when the project as whole as multiple contributors, but one particular release is handled by a single contributor.

What do you think?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions