Repository metrics
- Stars
- (1 star)
- PR merge metrics
- (PR metrics pending)
Description
Some variables have too generic names that do not indicate their role. Renaming them in accordance with their role and the constraints below will make the project easier to understand and debug.
Constraints
- You should understand their role based on their name (see Variables description in CONTRIBUTING)
- All variables must be prefixed by
JO_JOIN_ - All CAPS, exception if the variable is linked to a trigger, like
JO_Myself_LeavePartywhich is similar toLeaveParty(Myself) - The name must be <= 32 characters long, ideally <= 24.
- ?
- Add Constraints to CONTRIBUTING
- Re-read the name variables and explain it, while respecting the constraints
- After validation by the maintainer
- Upgrade CONTRIBUTING file
- Use them in the code
Bad examples:
JO_JOINIJO_JOIN_JOIN
Various proposals:
JO_JOIN_AREA → JO_JOIN_IS_MASTER_AREAJO_JOIN_SWITCHING → JO_JOIN_SWITCHING_PARTYJO_JOIN_LOADING → JO_JOIN_LOADING_SWITCHJO_JOIN_CLEAR → JO_JOIN_SET_JOINXJO_JOIN_IS_HIDDEN → JO_JOIN_IS_HIDDEN_BY_CUT
JO_JOIN_Move_Around → JO_JOIN_DLG_OPTION
JO_JOIN_Move_Done → JO_JOIN_DLG_OPTION_DONE
JO_JOIN_SWITCH_WITH_ME → JO_JOIN_SWITCH_NEXT_SLOT
JO_JOIN_Wannabe → JO_JOIN_WANNABE_TRAVELERJO_JOIN_IS_Wannabe → JO_JOIN_WANNABE_INITJO_JOIN_READY_TO_SWITCH → JO_JOIN_PARTY_SWITCH_STATEJO_JOIN_NEVER_SWITCH → JO_JOIN_NO_PARTY_SWITCHJO_JOIN_FORCE_SWITCH → JO_JOIN_FORCE_QUICK_SWITCH
JO_JOIN_NEVER_JOIN → JO_JOIN_NEVER_QUICK_SWITCH
JO_JOIN_Fill_Party → JO_JOIN_READY_TO_FILL