Accepted: Keep a changelog

  • Status: accepted

Context and Problem Statement

Humans need to know what has changed

Describe the feature / enhancement and how it helps to overcome the problem or limitation

Copied from https://keepachangelog.com.

What is a changelog?

A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. Why keep a changelog?

To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. Who needs a changelog?

People do. Whether consumers or developers, the end users of software are human beings who care about what’s in the software. When the software changes, people want to know why and how.

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

Keep a changelog.

  1. Use the https://github.com/V-Sekai/v-sekai-proposals #repository as a placeholder.
  2. Delay migrations to main project #repository to a later date.

If this enhancement will not be used often, can it be worked around with a few lines of script?

Not code.

Positive Consequences

No response

Negative Consequences

No response

Is there a reason why this should be core and done by us?

We are the best to know what changed.

References

  • https://keepachangelog.com/en/1.0.0/

Derivative License

Copyright (c) 2020-2021 V-Sekai contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.