11jo/JOining_Party

Renaming variables

Open

#10 opened on Oct 28, 2025

View on GitHub
 (29 comments) (0 reactions) (0 assignees)DTrace (0 forks)auto 404
documentationenhancementgood first issue

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

  1. You should understand their role based on their name (see Variables description in CONTRIBUTING)
  2. All variables must be prefixed by JO_JOIN_
  3. All CAPS, exception if the variable is linked to a trigger, like JO_Myself_LeaveParty which is similar to LeaveParty(Myself)
  4. The name must be <= 32 characters long, ideally <= 24.
  5. ?

  • 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_JOINI
  • JO_JOIN_JOIN

Various proposals: JO_JOIN_AREAJO_JOIN_IS_MASTER_AREA JO_JOIN_SWITCHINGJO_JOIN_SWITCHING_PARTY JO_JOIN_LOADINGJO_JOIN_LOADING_SWITCH JO_JOIN_CLEARJO_JOIN_SET_JOINX JO_JOIN_IS_HIDDENJO_JOIN_IS_HIDDEN_BY_CUT JO_JOIN_Move_AroundJO_JOIN_DLG_OPTION JO_JOIN_Move_DoneJO_JOIN_DLG_OPTION_DONE JO_JOIN_SWITCH_WITH_MEJO_JOIN_SWITCH_NEXT_SLOT JO_JOIN_WannabeJO_JOIN_WANNABE_TRAVELER JO_JOIN_IS_WannabeJO_JOIN_WANNABE_INIT JO_JOIN_READY_TO_SWITCHJO_JOIN_PARTY_SWITCH_STATE JO_JOIN_NEVER_SWITCHJO_JOIN_NO_PARTY_SWITCH JO_JOIN_FORCE_SWITCHJO_JOIN_FORCE_QUICK_SWITCH JO_JOIN_NEVER_JOINJO_JOIN_NEVER_QUICK_SWITCH JO_JOIN_Fill_PartyJO_JOIN_READY_TO_FILL

Contributor guide