superposition icon indicating copy to clipboard operation
superposition copied to clipboard

chore: add cline memory-bank & rules

Open divinenaman opened this issue 9 months ago • 0 comments

Problem

add cline memory-bank & rules ~~manually~~ using LLMs

Solution

memory bank is divided into 6 files

  1. product.md : Give a detailed, well researched description about the project. Mention the problems it is trying to solve and document other aspect/features unique. Figure out the users, actors and entities in the project. Think Step by Step.
  2. subsystems : Identify the various subsystems in the project. Subsystems are the nodes/features that work together for a happy run of the project. These subsystems give a deterministic path to evalaute/build features in the codebase.
  3. framework : Describe the technologies being used. Document the frameworks and abstractions the project is using. Every project has a defined method to do things, research for these and document it. This should be a detailed doc, to help developers contribute to the project. Describe how task like UI, API calls, data updation and other things are managed with the framework used. Define the rules of the framework and abstractions in use.
  4. development : Identify all the important classes, objects, interfaces, types or any other important programming langauge specific values/first class citizens unique to the project. Describe the various modules/screens/packages/subsystems in the project and how they interact with each other. Define any service contracts maintained while interacting with them. Find the common patterns to do various task and document for references.
  5. navigation : Describe the project organization, how to navigate the project. Describe how subsystems interact and how context switch happens. Describe the lifecycle of various components in the project. Explain how data is fetched, validated, updated and organized. List down API calls required by the project, create an exhaustive list of all APIs.
  6. features : Identify all the features/behaviors in the project. Explain all these features with logic, branching, input, outputs, how they can be triggered, controlled, how they interact with the various subsystems and what is the relation between them. Think deeply, cover all important features, create an exhaustive list of all features. Do not limit/assume things, keep on analysing until all the aspects are clear. Explain the input and output helping a developer to test/enable/disable flows/features.

Environment variable changes

What ENVs need to be added or changed

Pre-deployment activity

Things needed to be done before deploying this change (if any)

Post-deployment activity

Things needed to be done after deploying this change (if any)

API changes

Endpoint Method Request body Response Body
API GET/POST, etc request response

Possible Issues in the future

Describe any possible issues that could occur because of this change

divinenaman avatar May 21 '25 08:05 divinenaman