Skip to content

Commit

Permalink
update conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
valoeghese committed Feb 20, 2021
1 parent 8cef646 commit 75f863a
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions CONVENTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,8 @@

1. Use British English.

2. Use concise names. e.g. `Creeper` instead of `CreeperEntity`

2a. Where concise names such as `Bed` could be multiple things, use the concise name for what the name is used to reference most often (In this case "Bed" is mostly thought of as a tile/block, so it is given to that)

2b. Where the concise name is better used / already used for another class, append the type to the end. e.g. Bed: (the tile is "Bed", the itemtype is "BedItem", and the entity is "BedEntity")
2. Use concise names for Entities, TileEntities, Biomes and Dimensions. e.g. `Creeper` instead of `CreeperEntity`

3. Use outdated, cursed Mojang names where applicable. e.g Tile instead of Block

4. ~~The mappings are cursed. Feel free to make cursed names where appropriate~~ not really anymore

5. Notwithstanding these rules, the name must still make some sense
4. Notwithstanding these rules, the name must still make some sense

0 comments on commit 75f863a

Please sign in to comment.