Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Changelogs for releases #1138

Closed
heinezen opened this issue Jun 28, 2019 · 3 comments
Closed

Changelogs for releases #1138

heinezen opened this issue Jun 28, 2019 · 3 comments
Labels
documentation Involves the project documentation nice new thing ☺ A new feature that was not there before to-discuss Idea or suggestion that needs some discussion before implementation
Projects
documentation

Comments

@heinezen
Copy link
Member

Currently our release descriptions only include highlights from the release. It would be nice to have comprehensive changelogs that track every change. Changelogs would be great for people who want to get a quick overview or who abstained from the project for a longer time and are trying to start contributing again.

I would suggest Keep a Changelog for the format because it's nice and simple without fancy stuff. Additionally, we should think about keeping separate changelogs for user facing interfaces such as

  • Modding API (data, scripting, UI)
  • Python Interface
  • In-game Editor
  • .sprite and .terrain formats
  • etc...
@simonsan simonsan added this to To do in documentation via automation Jun 28, 2019
@simonsan simonsan added the documentation Involves the project documentation label Jun 28, 2019
@heinezen heinezen added nice new thing ☺ A new feature that was not there before to-discuss Idea or suggestion that needs some discussion before implementation labels Jun 28, 2019
@zuntrax
Copy link
Contributor

zuntrax commented Jun 30, 2019

I like that.

@TheJJ
Copy link
Member

TheJJ commented Jul 1, 2019

Sounds good. I'd avoid something that leads to one file getting bigger and bigger forever, instead use a new file every once in a while, or even for each release.

@simonsan
Copy link
Contributor

simonsan commented Sep 6, 2019

Closed du to PR #1143

@simonsan simonsan closed this as completed Sep 6, 2019
documentation automation moved this from To do to Done Sep 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Involves the project documentation nice new thing ☺ A new feature that was not there before to-discuss Idea or suggestion that needs some discussion before implementation
Projects
documentation
  
Done
Milestone
No milestone
Development

No branches or pull requests
4 participants
@TheJJ @zuntrax @heinezen @simonsan