Skip to content

CHANGELOG contributing guidelines are unclear #926

@strugee

Description

@strugee

Bug Overview

https://github.com/nginx/ansible-role-nginx/blob/5271d0c6b23f81bbbebed427b460330b2d04158f/CONTRIBUTING.md#git-guidelines says to use Conventional Commit formatting "so that changelogs can be automatically generated". But, https://github.com/nginx/ansible-role-nginx/blob/5271d0c6b23f81bbbebed427b460330b2d04158f/.github/pull_request_template.md prompts the contributor to update any relevant documentation, including CHANGELOG.md.

These statements seemingly conflict, and are confusing for new contributors.

Expected Behavior

Clear instructions about whether the CHANGELOG be updated by hand or not.

Steps to Reproduce the Bug

N/A

Environment Details

N/A

Additional Context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions