CONTRIBUTING.md: fiddle with layout

This commit is contained in:
Starbeamrainbowlabs 2021-07-27 00:38:51 +01:00
parent db8aef5f7c
commit a3bba21266
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
1 changed files with 12 additions and 11 deletions

View File

@ -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