SkriptLang / Skript

Skript is a Spigot plugin which allows server admins to customize their server easily, but without the hassle of programming a plugin or asking/paying someone to program a plugin for them.
https://docs.skriptlang.org
GNU General Public License v3.0
1.06k stars 368 forks source link

Changes to code-conventions.md #5125

Open Fusezion opened 2 years ago

Fusezion commented 2 years ago

Suggestion

Add a "good" example along side biome conventions to help people understand what steps we should use for code related to biomes.

Why?

There is no current good example within it currently and while reading it made it hard to think of a solid way to make a good one. If I compare this with the convention related to "Avoid referencing Material enum" there's a good example that make use of skript's aliases, and helps make sense of what we should use.

Other

https://github.com/SkriptLang/Skript/blob/9f6ce128b422203df328147825a7dff1561b2261/code-conventions.md?plain=1#L160-L166

Agreement

Fusezion commented 2 years ago

Updating this to include other portions as well. We should also add SkriptEvent order to the override method order list EX: init -> check -> toString

https://github.com/SkriptLang/Skript/blob/9f6ce128b422203df328147825a7dff1561b2261/code-conventions.md?plain=1#L70-L77

Fusezion commented 1 year ago

Include annotation order for documentation annotation

@Name
@Description
@Examples
@Since
(@Requiredplugins)
@Events