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 diff --git a/README.md b/README.md index 43291c6..ff616f6 100644 --- a/README.md +++ b/README.md @@ -138,9 +138,7 @@ As far as I can tell, the saplings provided by the [`moretrees` mod](https://con ## Contributing Contributions are welcome! Please state in your pull request(s) that you release your contribution under the _Mozilla Public License 2.0_. -Please also make sure that the logic for every new command has it's own file. For example, the logic for `//floodfill` goes in `worldeditadditions/floodfill.lua`, the logic for `//overlay` goes in `worldeditadditions/overlay.lua`, etc. More contributing help can be found in [the contributing guide](./Contributing.md) - -For more information check out [CONTRIBUTING.md](CONTRIBUTING.md). +Please also make sure that the logic for every new command has it's own file. For example, the logic for `//floodfill` goes in `worldeditadditions/floodfill.lua`, the logic for `//overlay` goes in `worldeditadditions/overlay.lua`, etc. More contributing help can be found in [the contributing guide](CONTRIBUTING.md). For more information check out [CONTRIBUTING.md](CONTRIBUTING.md).