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.

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

Better handling of a breaking change #2236

Closed
2 tasks
tlylt opened this issue Mar 26, 2023 · 1 comment
Closed
2 tasks

Better handling of a breaking change #2236

tlylt opened this issue Mar 26, 2023 · 1 comment

Comments

@tlylt
Copy link
Contributor

tlylt commented Mar 26, 2023

Please confirm that you have searched existing issues in the repo

Yes, I have searched the existing issues

Any related issues?

No response

Tell us about your environment

Windows 10

MarkBind version

Master branch

Describe the bug and the steps to reproduce it

During release management, the release personnel needs to look through the completed PRs and find out

  • what is breaking
  • what needs to be done for a user to migrate
  • write that down in the release draft

Would be great if the author who knows the PR best assist in the above steps, potentially collaborating with the PR reviewer then and there.
See example of a breaking change release note:
https://github.com/MarkBind/markbind/releases/tag/v4.0.0

Also, new contributors may not even be educated on what's breaking or commonly breaking in MarkBind

Expected behavior

  • Add in dev guide some explanation on what are the common breaking changes in MarkBind and what to do about it
    • Education
  • Include a section and a short explanation in the PR template to leave out space for this, to guide devs filling up the relevant info for future release
    • Practical

Anything else?

@MarkBind/contributors can tackle this as part of the managing stage

@tlylt
Copy link
Contributor Author

tlylt commented Nov 21, 2023

Covered by PR #2361

@tlylt tlylt closed this as not planned Won't fix, can't repro, duplicate, stale Nov 21, 2023
@tlylt tlylt closed this as completed Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant