-
Notifications
You must be signed in to change notification settings - Fork 23
Open
Labels
component: backendPull requests that update Go codePull requests that update Go codegood first issueGood for newcomersGood for newcomerslanguage: Gostatus: newtype: pedantic
Milestone
Description
Description
Ensure that method argument names serving the same purpose use a consistent naming convention across the codebase.
In the backend codebase, some arguments with the same meaning are named differently. For example: perm vs. permission. Using inconsistent names makes the code harder to read and maintain. Plural forms should also be unified (e.g., perms vs. permissions), but not replaced with singular forms if they are meant to be plural.
Tasks
- Search the backend codebase for arguments with similar meanings but different names.
- Decide on a single, clear name for each case.
- Replace inconsistent names with the chosen one throughout the codebase.
- Ensure that:
- Plural forms stay plural.
- Variable names are at least 3 characters long, unless they are loop variables.
- Test the code after changes to confirm nothing is broken.
Notes
- Focus on meaning and readability over personal preference.
- Consistency improves maintainability and reduces onboarding time for new contributors.
- Ensure the Open API specification is updated as needed
- If the specification has been updated, regenerate the server and client using
make generate.server generate.client
Metadata
Metadata
Assignees
Labels
component: backendPull requests that update Go codePull requests that update Go codegood first issueGood for newcomersGood for newcomerslanguage: Gostatus: newtype: pedantic