Skip to content

3.8 Changelog Update#7277

Merged
harry-cpp merged 7 commits intoMonoGame:developfrom
SickheadGames:3_8_changelog
Aug 6, 2020
Merged

3.8 Changelog Update#7277
harry-cpp merged 7 commits intoMonoGame:developfrom
SickheadGames:3_8_changelog

Conversation

@tomspilman
Copy link
Copy Markdown
Member

This is the change log for 3.8.

Note that moving forward we plan to keep the change log updated as we go. This will require people submitting PRs to update the changelog for their changes/features.

CHANGELOG.md Outdated
# Change Log

## 3.8 Unreleased - 2020-08-??

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add some sort of summary to the release?

@SimonDarksideJ
Copy link
Copy Markdown
Contributor

These more readable notes are a lot better @tomspilman

@Jjagg
Copy link
Copy Markdown
Contributor

Jjagg commented Aug 4, 2020

I think generally the changelog isn't great because commit messages or PR titles tend to be more developer-oriented while the changelog is for people using MonoGame and should not be about implementation. For example a change I did had the message

Use short for parameter count in effect binary.

while the actual problem this fixed was #5995, so I changed the message to

Support arrays > 255 elements in shaders.

in SickheadGames#19. That conveys what's actually interesting to MG users. Things that are not interesting for MG users should not be in the changelog IMO (except big stuff like the Protobuild migration).
I also don't think documentation changes should go in the changelog. There's also a bunch of entries that relate to fixes after migrating to the SDK project system and to .NET Core which are not useful for users to read through and which would never have had a changelog entry if we manually kept it.

I don't think we should spend hours going through these entries though. This will be better from now on with a manual changelog.

Jjagg and others added 2 commits August 4, 2020 16:27
@harry-cpp harry-cpp merged commit d4905f4 into MonoGame:develop Aug 6, 2020
@tomspilman
Copy link
Copy Markdown
Member Author

@Jjagg @harry-cpp in the future on doc PRs like this we should always "squash and merge". Don't think it is useful to have a dozen random doc edit commits in the history.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants