Skip to content

Conversation

@gustaavik
Copy link
Member

This pull request introduces a comprehensive development guidelines document for the Commercify e-commerce backend API. The document outlines best practices, architectural principles, coding standards, and other essential guidelines to ensure code consistency, maintainability, and adherence to project architecture.

Added Development Guidelines

  • Architectural Principles: Defines the Clean Architecture layers (Domain, Application, Infrastructure, Interfaces) and the dependencies rule to ensure proper separation of concerns. (.github/copilot-instructions.md, .github/copilot-instructions.mdR1-R269)
  • Code Structure: Provides a directory structure for organizing the project, including layers for API, application logic, domain entities, and infrastructure. (.github/copilot-instructions.md, .github/copilot-instructions.mdR1-R269)

Coding Standards and Practices

API and Testing Guidelines

  • API Design: Covers RESTful principles, versioning, security, and a standardized format for documenting API endpoints. (.github/copilot-instructions.md, .github/copilot-instructions.mdR1-R269)
  • Testing: Emphasizes unit and integration testing with mocks, test databases, and cleanup practices. (`.github/copilot

@gustaavik gustaavik requested a review from Copilot April 30, 2025 20:03
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request introduces a comprehensive development guidelines document for the Commercify e-commerce backend API. The document details architectural principles, code structure recommendations, coding standards, and testing practices to ensure consistency and maintainability.

  • Introduces Clean Architecture principles and dependency rules.
  • Outlines a recommended directory structure.
  • Specifies guidelines for coding standards, error handling, testing, and API documentation.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@gustaavik gustaavik merged commit 05f826f into development Apr 30, 2025
@gustaavik gustaavik deleted the copilot-basic-instructions branch April 30, 2025 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants