Introducing the Partner Platform Squad Code Convention 🌼

Olive Young's Partner Platform Squad established a code convention to enhance code readability, maintainability, and team collaboration, based on feedback gathered during the service improvement process.

The main convention contents are as follows.

• Editor settings: Use .editorconfig to consistently manage IDE (IntelliJ IDEA, etc.) indentation, encoding, and more.
• Package structure: Design an extensible structure centered on separating dependencies from domain/business logic.
• Naming rules: Avoid the use of abbreviations, and define method names differently by layer (Controller, Service, Repository) to clearly distinguish their roles (business logic vs. data access).
• API design: Use singular nouns for URIs, and specify bulk when bulk processing is required. Also actively utilize HTTP Methods to manage resources.
• Response specification: Apply consistent Response codes and message rules. Use a Generic type for list data to unify the response format, and include an identifier in single-resource responses to help clients with post-processing.