Skip to content

Commit

Permalink
Update guidelines.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DrTheodor authored Sep 18, 2024
1 parent 93764b1 commit 46bc882
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions content/development/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,23 @@ public void setMyValue(SomeClass some) {
```
(you'd probably want to make a getter for the raw value too, since otherwise you'd allow other classes to bypass the setter)

## IDs
TARDIS component ID names should be upper snake case in english without special symbols (except for underscores and colons).

If you add a custom component in an addon it's recommended to prefix it with your mod id (in uppercase).

ID name shouldn't include "handler" or "component".

**Do**'s:
- `TRAVEL`
- `FLIGHT`
- `STATS`
- `AITE:ENERGY`

**Don't**'s:
- `MyComponent`
- `Some Handler`
- `idontlikespaces`
- `thisSucks`


0 comments on commit 46bc882

Please sign in to comment.