Merge branch 'guidelines' of https://git.minetest.land/EliasFleckenstein03/MineClone2 into guidelines

Elias Fleckenstein 2021-10-25 17:21:09 +02:00
commit 4776487f83
No known key found for this signature in database
GPG Key ID: 06927A5199D6C9B2

@ -5,7 +5,7 @@ Wow, thank you! :-)
But first, some things to note: But first, some things to note:
MineClone2's development target is to make a free software clone of Minecraft, MineClone2's development target is to make a free software clone of Minecraft,
***version 1.17***, ***Java Edition***, *** + Optifine features supported by the Minetest Engine***. The priority is making polished features up to version 1.12. ***version 1.17***, ***Java Edition***, ***+ Optifine features supported by the Minetest Engine***. The priority is making polished features up to version 1.12.
MineClone2 is maintained by Nicu and Fleckenstein. If you have any MineClone2 is maintained by Nicu and Fleckenstein. If you have any
problems or questions, contact us (See Links section below). problems or questions, contact us (See Links section below).
@ -40,7 +40,7 @@ report a bug or request a feature.
### Rules about both bugs and feature requests ### Rules about both bugs and feature requests
* Stay polite towards the developers and anyone else involved in the discussion. * Stay polite towards the developers and anyone else involved in the discussion.
* Choose a descriptive title. * Choose a descriptive title.
* Try to use proper english and please start the title with a capital letter. * Try to use proper English and please start the title with a capital letter.
* Always check the currently opened issues before creating a new one. Don't report bugs that have already been reported or request features that already have been requested. * Always check the currently opened issues before creating a new one. Don't report bugs that have already been reported or request features that already have been requested.
* If you know about Minetest's inner workings, please think about whether the bug / the feature that you are reporting / requesting is actually an issue with Minetest itself, and if it is, head to the [Minetest issue tracker](https://github.com/minetest/minetest/issues) instead. * If you know about Minetest's inner workings, please think about whether the bug / the feature that you are reporting / requesting is actually an issue with Minetest itself, and if it is, head to the [Minetest issue tracker](https://github.com/minetest/minetest/issues) instead.
* If you need any help regarding creating a Mesehub account or opening an issue, feel free to ask on the Discord / Matrix server or the IRC channel. * If you need any help regarding creating a Mesehub account or opening an issue, feel free to ask on the Discord / Matrix server or the IRC channel.
@ -94,7 +94,7 @@ If your code leads to bugs or crashes after being merged, it is your responsibil
* Each mod which add API functions should store functions inside a global table named like the mod. * Each mod which add API functions should store functions inside a global table named like the mod.
* Public functions should not use self references but rather just access the table directly. * Public functions should not use self references but rather just access the table directly.
* Use modern Minetest API * Use modern Minetest API
* Use tabs instead of spaces * Use tabs for indentation (rather than spaces)
* Even if it improves performance, it is discouraged to localize variables at the beggining of files, since if another mod overrides some of the functions / variables you localized, you will still have a reference to the old function. * Even if it improves performance, it is discouraged to localize variables at the beggining of files, since if another mod overrides some of the functions / variables you localized, you will still have a reference to the old function.
### Changes to Gameplay ### Changes to Gameplay