Skip to content

docs: CONTRIBUTING.md references nonexistent CHANGELOG.md #203

@groundnuty

Description

@groundnuty

Description

CONTRIBUTING.md lists "Update CHANGELOG.md" as step 4 of the Pull Request Process, and the PR Checklist doesn't mention it but the workflow section does.

However, no CHANGELOG.md file exists in the repository. The project currently uses the release-note block in the PR template for tracking changes instead.

This creates confusion for new contributors who try to follow the guide.

Suggested Resolution

Either:

  1. Remove the CHANGELOG.md reference from CONTRIBUTING.md, since the release-note block in the PR template already serves this purpose.
  2. Create a CHANGELOG.md and establish a convention for maintaining it (manually or via automation like release-please).

Change Type

/kind cleanup

Additional Notes

Found while preparing my first contribution (PR #202). Happy to submit a fix once the team decides which direction to go.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions