diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b1868625d..e6937a6ad8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,7 +99,8 @@ Fabric API makes strong backwards compatibility guarantees, by which contributor - If vanilla exposes optionals in return types, then returning an optional is fine. - Avoid requiring the user to cast to a subtype if possible. - Adding methods to vanilla types can be done via interface injection. -- Avoid exposing java `records` as public API +- Avoid exposing java `records` as public API. + - Records expose more than is necessary for most APIs, which makes them difficult to evolve. - Prefer to expose an interface that is implemented by an impl record. ### API design patterns to consider