Skip to content

Add breaking changes to the changelog #722

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

Open
SMoraisAnsys opened this issue Mar 5, 2025 · 0 comments · May be fixed by #810
Open

Add breaking changes to the changelog #722

SMoraisAnsys opened this issue Mar 5, 2025 · 0 comments · May be fixed by #810
Assignees
Labels
enhancement General improvements to existing features

Comments

@SMoraisAnsys
Copy link
Contributor

📝 Description of the feature

A great enhancement (very subjective) to the changelog would be to have a section "breaking changes" when a PR has introduced such kind of changes.

Following the conventional commits, introducing a breaking change can be expressed in a commit (here PR) if it has a footer (here PR title) BREAKING CHANGES: OR appends a ! after the type/scope.

If such feature makes sense to you too, we can even think about having a common doc files for the breaking changes, e.g. the same kind of file we are using for the migration in the ansys/actions, and have a direct link added to this file in the change log or the release notes !

💡 Steps for implementing the feature

No response

🔗 Useful links and references

@SMoraisAnsys SMoraisAnsys added the enhancement General improvements to existing features label Mar 5, 2025
@SMoraisAnsys SMoraisAnsys self-assigned this Mar 5, 2025
@SMoraisAnsys SMoraisAnsys linked a pull request May 10, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement General improvements to existing features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant