toddams / RazorLight

Template engine based on Microsoft's Razor parsing engine for .NET Core
Apache License 2.0
1.51k stars 261 forks source link

Change Logs #379

Closed HamiltonManalo closed 3 years ago

HamiltonManalo commented 3 years ago

With the release of beta10 I had the realization that currently were not creating change logs with each release. One recent PR I created had a major breaking change in it that was released without any kind of notice. I realize this is quite a bit of work. But would the community, and @jzabroski consider attempting to maintain a change log and make submitting change log details part of the PR process for new PRs?

That would at least provide a trail of breadcrumbs for users to reference when the project breaks after an update.

jzabroski commented 3 years ago

I've been creating release notes. I didn't do it yet for beta10 since I was heading on vacation.

On Thu, Oct 15, 2020, 1:35 PM HamiltonManalo notifications@github.com wrote:

With the release of beta10 I had the realization that currently were not creating change logs with each release. One recent PR I created had a major breaking change in it that was released without any kind of notice. I realize this is quite a bit of work. But would the community, and @jzabroski https://github.com/jzabroski consider attempting to maintain a change log and make submitting change log details part of the PR process for new PRs?

That would at least provide a trail of breadcrumbs for users to reference when the project breaks after an update.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/toddams/RazorLight/issues/379, or unsubscribe https://github.com/notifications/unsubscribe-auth/AADNH7ISBB3J7YLICHLZQDLSK4XH7ANCNFSM4SSJI5CQ .

HamiltonManalo commented 3 years ago

Ah, sounds good then.