Skip to content

Instantly share code, notes, and snippets.

View hpxio's full-sized avatar
:octocat:

Harsh P Shekhar hpxio

:octocat:
  • Ticketmaster
  • India
  • 01:25 (UTC +05:30)
View GitHub Profile

Below is an explanation of the mentioned diagrams, their purpose, and the stages of software development where they are typically used.
The software development lifecycle (SDLC) stages referenced include Requirement Analysis, Design, Implementation, Testing, and Maintenance.

1. Component Diagram

  • Purpose: Shows the structural relationships between components (modules, libraries, or services) in a system, illustrating how they interact to provide functionality.
  • SDLC Stage: Design (High-Level Design phase). Used to define the system’s modular structure and dependencies.
  • Use Case: Helps developers and architects understand how components fit together, especially in modular or microservices architectures.

2. Architecture Diagram

  • Purpose: Provides a high-level view of the system’s structure, including major components, their interactions, and the technology stack.
@hpxio
hpxio / Code-Review-Guidelines.md
Last active December 2, 2025 09:34
Handling Code Review & Merge Request

Code Review & Merge Request

Reviews are an essential step of the development process. They are also the best way to improve a team's skills and quality of the code. Every review and comment should be treated as a growth opportunity.

Approval & Approvers

  • Merge requests need to have two format approvals from any of the people with the right to do so in the project.
  • Approval right is earned through active reviewing on own team & other teams MR's
  • Approval right can be lost
  • Feature -> Master MR's that already had it's content review through task -> feature MR's don't need actual review/approval but that's not something we can configure in gitlab so approvals should be given as soon as such a MR appears.

Code Review Best Practices