v0.5.8 README

[yuanming-hu]

Trying to separate visible changes from underlying development ("Full log"). Let me know if this makes sense to you guys. We should end up with a formal and consistent format for the release log.

Maybe every PR author should keep in mind that their PR titles will be potentially part of the release log.

[Click here for the format server]

[k-ye]

Looks good!

BTW, in my team we have a few tags like this:

new

• feature1
• feature2

fixes

• bug1
• bug2

other tags

...

Would that make it easier to write this log? (But i do see other project's commits with a pattern of [XX] Title of a PR, so probably this in the standard approach..)

[yuanming-hu]

Looks good!

BTW, in my team we have a few tags like this:

new

• feature1
• feature2

fixes

• bug1
• bug2

other tags

...

Would that make it easier to write this log? (But i do see other project's commits with a pattern of [XX] Title of a PR, so probably this in the standard approach..)

I agree. Updated the list. As we have more and more contributions/releases, it's worth considering making the changelog generation automatic. I propose that we always prepend a PR tag such as [Metal backend] to the PR title.

In addition, although we do appreciate all kinds of contributions, we should not expose every PR to the end-users - otherwise, users will get rather confused when seeing a super long changelog. We should use the releases page for the full changelog.

I suggest that we follow this simple rule:

• PRs with visible/notable features to the users should be marked with tags starting with first letter capitalized, e.g. [Metal backend], [OpenGL backend], [IR], [Lang], [CLI],
• Other PRs (underlying development/intermediate implementation) should use tags with everything in lower-case: e.g. [metal backend], [opengl backend], [ir], [lang], [cli]

I believe this will not only make generating the changelog easier, but also make the PRs more organized. What do you think? @k-ye @archibate If we all agree I'll put it in the contributor guideline.

A list of tags: (feel free to propose more. We can also invent more tags when merging PRs.)
[Metal backend], [OpenGL backend], [CPU backend], [CUDA backend], [IR], [Lang], [CLI], [Util], [Infra], [Misc] (Infra is for low-level infrastructure)

[yuanming-hu]

I'm merging this in so that people can see a change log in time. Feel free to continue the discussions! Thanks.