Skip to content

Guidelines for handling breaking changes #3703

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 26, 2025
+14 −0
Merged

Guidelines for handling breaking changes #3703

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3b2d6d
Add guidelines for handling breaking changes
hazzik Sep 22, 2025
26b3983
Fix links
hazzik Sep 22, 2025
c732eca
Merge branch 'master' into contributing-breaking-changes
hazzik Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,18 @@ We use tabs for code indentation, not spaces. To make this easier, NHibernate ha

After submitting your pull request, come back later to check the outcome of automated builds. If some have failed, they will be listed in your pull request with a link to the corresponding TeamCity build. Find out in the build which tests are newly failing, and take appropriate action. Some of those builds may have known failing tests, which does not trigger a build failure. In this case a *Comparison.txt* file in build Artifacts may help finding which failing tests are not known failing tests and must be addressed.

## Breaking Changes

* Avoid binary breaking changes (changes that make previously compiled user assemblies fail to load or run: removed/renamed public members, signature changes, sealed/abstract changes impacting inheritance, etc.).
* Source and behaviour breaking changes are acceptable when they provide clear value and are documented.

When you introduce any breaking change:
1. Clearly state it in the PR description under a heading: `Breaking Changes` (list each item).
2. Provide a concise migration note (old → new) for each item.
3. Update tests without deleting coverage.

See Microsoft guidance: the [.NET library breaking change guidance][5] and the [.NET compatibility change rules][6] for definitions and recommended practices.

## Further Discussion

The NHibernate team monitors GitHub regularly, so your request will be noticed. If you want to discuss it further, you are welcome to post to the [nhibernate-development mailing list][4].
Expand All @@ -116,3 +128,5 @@ The NHibernate community values your contributions. Thank you for the time you h
[2]: https://github.com/nhibernate/nhibernate-core/
[3]: http://www.editorconfig.org/
[4]: http://groups.google.com/group/nhibernate-development
[5]: https://learn.microsoft.com/en-us/dotnet/standard/library-guidance/breaking-changes
[6]: https://learn.microsoft.com/en-us/dotnet/core/compatibility/library-change-rules
Loading