From 182a180c2e150665e19fcc92f123ce5ed17c2409 Mon Sep 17 00:00:00 2001 From: p2r3 <41925384+p2r3@users.noreply.github.com> Date: Tue, 23 Sep 2025 13:25:45 +0300 Subject: [PATCH] update contribution guidelines --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 16b5b0e..c06a6f1 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,8 @@ If using an SD card module or other virtual file system, you'll have to implemen Alternatively, if you can't set up a file system, you can dump and upload world data over TCP. This can be enabled by uncommenting `DEV_ENABLE_BEEF_DUMPS` in `globals.h`. *Note: this system implements no security or authentication.* With this option enabled, anyone with access to the server can upload arbitrary world data. ## Contribution -- Create issues and discuss with the maintainer(s) before making pull requests. +- Create issues and discuss with the maintainer(s) before making pull requests. Even for small changes. - Follow the existing code style. Ensure that your changes fit in with the surrounding code, even if you disagree with the style. Pull requests with inconsistent style will be nitpicked. - Test your code before creating a pull request or requesting a review, regardless of how "simple" your change is. It's a basic form of respect towards the maintainer and reviewer. -- Development tooling and compilation improvements _are not welcome,_ unless you've worked with the codebase long enough to have noticed practical shortcomings in that area. I'm tired of receiving tooling PRs from people who don't intend to work with those tools. \ No newline at end of file +- Development tooling and compilation improvements _are not welcome,_ unless you've worked with the codebase long enough to have noticed practical shortcomings in that area. Adding a single compiler flag is not a meaningful first contribution. +- For information on the Minecraft server protocol, [refer to the wiki](https://minecraft.wiki/w/Java_Edition_protocol/Packets). For everything else, use a [search engine](https://google.com). \ No newline at end of file