mmo-ref/mc-fabric-api
1
0
Fork 0
mirror of https://github.com/FabricMC/fabric synced 2026-08-19 06:26:07 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(CONTRIBUTING.md): make constructors private in utility classes (#5490)

Browse source 
* docs(CONTRIBUTING.md): privatize constructors in utility classes

* fix(CONTRIBUTING.md): multiple private constructors

* fix(CONTRIBUTING.md): formatting and grammar errors

* fix(CONTRIBUTING.md): privatize -> make private
This commit is contained in:
Sylv 2026-07-16 06:26:49 -04:00 • committed by GitHub
parent 309832e2ef
commit be49fc0a3b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -102,6 +102,8 @@ Fabric API makes strong backwards compatibility guarantees, by which contributor
- Avoid exposing java `record`s 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.
- Always make constructors `private` in utility classes.
- Utility classes are never instantiated, so ensure that they are final and their constructors are made `private`.
- Avoid creating constant interfaces or creating an interface that is never implemented and intended only to hold `static final` fields.
- Constant interfaces confuse users by suggesting they are intended to be implemented.
- This is a common Java anti-pattern.
@ -128,7 +130,7 @@ Fabric API makes strong backwards compatibility guarantees, by which contributor
}
// Holder class is not meant for instantiation.
private ExampleEvents() {
private FooEvents() {
}
}
```
@ -227,7 +229,7 @@ public final class FooEvents {
}
// Holder class is not meant for instantiation.
private ExampleEvents() {
private FooEvents() {
}
}
```