tumbledemerald-legacy/STYLE.md

13 lines
980 B
Markdown
Raw Normal View History

2022-05-19 19:14:13 +02:00
# Styling your code:
These guidelines are to be applied to all code contributed to the `tumbledemerald` project.
2022-10-19 02:17:53 +02:00
- Decapitalise everything! For example, change "POKéMON" to "Pokémon". This is almost already done thanks to the Python script, but make sure to keep an eye out!
2022-05-19 19:14:13 +02:00
- Always type "Pokémon" with the "é" Unicode character!
- When typing "Pokédex", make sure to type it without a capital "D".
2022-10-19 02:17:53 +02:00
- Use good English at all times, except when it doesn't make sense to do so.
2022-05-19 19:14:13 +02:00
- Abide by an 85-character "soft limit" per line of code. (This includes comments)
- If you decompile assembly (`.s` files) and a commit to `pret:master` later decompiles the same code, please revert your changes and add pret's
C or C++ code instead.
- Always comment your code, especially when writing it in assembly (`.s` and `.inc` files). In .c and .h files, comments start with two forward slashes (`//`) followed by one space. In .s and .inc files, use <at> (`@`) followed by one space.