Design Process

Once the feature request is approved, you need to create a system design. Follow the design process as outlined below:

1. In the same feature request .md file that you created for your feature, you need to continue in the same file by addding your design there. The following sections should be added:

   a) Design overview: Summarize the purpose and scope of the feature. Describe the overall approach and key components involved.

   b) System Design and its impact on other components (sub-system) of the system: Explain how the feature integrates with the existing system. Identify affected subsystems and describe any changes to their functionality or interactions.

   c) System architecture, where does it affect if any: Describe the architectural placement of the feature. Include details about any new services, APIs, or infrastructure components introduced or modified.

   d) Data design (mostly ORM/database modifications): Outline changes to the data model or database schema. Include any additions, deletions, or modifications to tables, fields, or relationships.

   e) Interface and Component Design: UML designs like class diagrams, sequence diagrams,etc: Provide design specifications for interfaces and components. Include relevant diagrams such as class diagrams, sequence diagrams, or state diagrams.

   f) Library Dependencies: List any new libraries or tools required. Include their purpose and any relevant details.

2. Once the design is written in the .md file, create PR to the dev and wait for approval

3. Go to the same issue that you had assigned yourself (while writing the feature) and write a brief summary of the design and wait for design committee approval