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

[ci skip] Mention API Checks for CONTRIBUTING.md #12315

Merged

Conversation

Doc94
Copy link
Contributor

@Doc94 Doc94 commented Mar 18, 2025

This PR try to add a mention in CONTRIBUTING.md for API Checks mostly because its a thing mentioned in PR/discord but not here.

Also try to include example using the formated methods. based in the Spigot mention of Preconditions.

@Doc94 Doc94 requested a review from a team as a code owner March 18, 2025 02:21
Doc94 and others added 2 commits March 19, 2025 11:47
Co-authored-by: Nassim Jahnke <nassim@njahnke.dev>
Co-authored-by: Nassim Jahnke <nassim@njahnke.dev>
@Lulu13022002
Copy link
Contributor

I'm not a fan of the example picked sendMessageComponent is ambiguous either you want to send a plain/mini message in that case rename the methods to match the api or a full component. Currently it looks like we support legacy formatting here. There should be also a mention about checkNotNull case (to not use it for the described reason).

Doc94 added 2 commits March 19, 2025 23:03
…xt and pretty sure use the serializer is a bad idea here then just change that example for another and ready
@kennytv kennytv merged commit 72f13f8 into PaperMC:main Mar 21, 2025
@Doc94 Doc94 deleted the feature/mention-api-checks-for-contributing branch March 21, 2025 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

3 participants