Keep a Changelog

Our changelog rules generally follow keepachangelog.com.

This project keeps the unreleased changes in yaml format under changelog/unreleased where each file represents an individual pull request. The file name is the pull request number.

WARNING

All other files in the changelog directory should not be manually modified as they are generated. While changelog/!unreleased.yaml will consider changes added to it directly, it should be avoided due to the high risk of merge conflicts.

To add a new changelog entry make a copy of the changelog/!template.yaml file under changelog/unreleased/{PR_NUMBER}.yaml and add as many entries as needed to the changes: array.

Each changes entry follows the following format:

# This can be either `security`, `deprecated`, `removed`, `added`, `fixed`, or `changed`.
# Pick one.
- type: "security | deprecated | removed | added | fixed | changed"
    # List of projects that were affected by the given change. Changes in nuget packages should include `App` and `CLI`.
    # `Core`, `Common`, `RED4` and `Modkit` are considered nuget packages.
    # Pick as many as apply.
    packages: ["App", "CLI", "Nuget Packages"]
    # Pull request number associated with this change.
    pr-number: 0
    # Authors github username, necessary for proper attribution
    author: ""
    # User facing change description
    description: ""