From a3bba21266c367fd4a95afa1085465a14c46c028 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Tue, 27 Jul 2021 00:38:51 +0100 Subject: [PATCH] CONTRIBUTING.md: fiddle with layout --- CONTRIBUTING.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b02dc46..1e6e84e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,18 @@ Additionally, every command should be implemented in its own file. This helps ke Don't forget to update `init.lua` to `dofile()` the new file(s) you create in each submod :-) + +## Guidelines +When actually implementing stuff, here are a few guidelines that I recommend to summarise everything: + + - Keep each command implementation to its own file + - Split up files with more than 500 lines into smaller chunks (such as what I've done with the `//convolve` implementation in the `worldeditadditions` submod) + - Try to follow the existing programming style + - If you think of something helpful to add to this guide, please open an issue / PR :D + - Being excellent to everyone shouldn't have to be on this list, but it is + - @sbrl has the final say + + ## Chat command template ```lua @@ -50,14 +62,3 @@ worldedit.register_command("{name}", { end }) ``` - - -## Guidelines -When actually implementing stuff, here are a few guidelines that I recommend to summarise everything: - - - Keep each command implementation to its own file - - Split up files with more than 500 lines into smaller chunks (such as what I've done with the `//convolve` implementation in the `worldeditadditions` submod) - - Try to follow the existing programming style - - If you think of something helpful to add to this guide, please open an issue / PR :D - - Being excellent to everyone shouldn't have to be on this list, but it is - - @sbrl has the final say