mirror of
https://github.com/sbrl/Minetest-WorldEditAdditions.git
synced 2024-08-20 13:34:05 +02:00
CONTRIBUTING.md: fiddle with layout
This commit is contained in:
parent
db8aef5f7c
commit
a3bba21266
@ -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 :-)
|
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
|
## Chat command template
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
@ -50,14 +62,3 @@ worldedit.register_command("{name}", {
|
|||||||
end
|
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
|
|
||||||
|
Loading…
Reference in New Issue
Block a user