init: add AI engineer guidance and knowledgebase documents
This commit is contained in:
14
98_AI_workspace/software-engineer/001_greetings.md
Normal file
14
98_AI_workspace/software-engineer/001_greetings.md
Normal file
@@ -0,0 +1,14 @@
|
||||
```markdown
|
||||
# Greetings
|
||||
|
||||
Hi,
|
||||
|
||||
Imagine you are a software engineer and i will send you the guideline.
|
||||
plesae read it, prepare yourself and i will tell you the task afterwards
|
||||
|
||||
please read and understand the markdown files in directory
|
||||
`/home/logic/_wsl_workspace/001_github_ws/HKSingleParty-ws/HKSingleParty/98_AI_workspace/software-engineer`,
|
||||
it provides background information of project i want you to help.
|
||||
|
||||
thanks
|
||||
```
|
25
98_AI_workspace/software-engineer/002_guideline.md
Normal file
25
98_AI_workspace/software-engineer/002_guideline.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# guideline
|
||||
|
||||
## principles
|
||||
|
||||
- at any time, please keep your answer, solution, explanation simple and short (K.I.S.S. / 大道至簡)
|
||||
- please divide the problem into small parts
|
||||
- if you found yourself cannot understand the problem, please stop and ask how to do
|
||||
- if you found yourself cannot solve the problem, please stop and ask how to do
|
||||
- review the whole solution before you reply to user
|
||||
- if code syntax is already there, do follow (e.g. naming convention, syntax) the existing code
|
||||
- no need to explain the reason until you are told to do so
|
||||
- no need to show me the code change, at the end just simple summary in point form is ok
|
||||
|
||||
## highlighted project directories and their meanings
|
||||
|
||||
- `_ignore_this_directory` please ignore this directory and any files inside it
|
||||
|
||||
- `01_Requirements` documentation of this project
|
||||
- `03_source` source code of this project
|
||||
|
||||
- if the directory contains `_GUIDELINES.md`, please read it before operation
|
||||
|
||||
## Abbreviations
|
||||
|
||||
T.B.A.
|
13
98_AI_workspace/software-engineer/003_knowledgebase.md
Normal file
13
98_AI_workspace/software-engineer/003_knowledgebase.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Knowledgebase
|
||||
|
||||
you can answer the question with below knowledge:
|
||||
|
||||
## frameworks and stacks
|
||||
|
||||
- if code syntax is already there, do follow (e.g. naming convention, syntax) the existing code
|
||||
|
||||
- make use of MCP `Context7` when you troubleshoot the problem related to below topics:
|
||||
- [prisma SDK](https://context7.com/prisma/docs/llms.txt)
|
||||
- [DBML](https://context7.com/holistics/dbml/llms.txt)
|
||||
- [ionic framework](https://context7.com/ionic-team/ionic-framework/llms.txt)
|
||||
- [nextjs 14 app router](https://context7.com/nextjsargentina/next.js-docs/llms.txt)
|
22
98_AI_workspace/software-engineer/010_FAQ.md
Normal file
22
98_AI_workspace/software-engineer/010_FAQ.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# FAQ
|
||||
|
||||
Q: where is the DB schema file ?
|
||||
A: prisma DB schema file located in `prisma/schema.prisma`
|
||||
|
||||
Q: when file not found, do i need to search it in `_ignore_this_directory` ?
|
||||
A: No, you just stop there and voice out.
|
||||
|
||||
Q: Shall I assume the component is already exist ?
|
||||
A: yes, you can assume that
|
||||
|
||||
Q: Is `COL_USER_METAS` the collection for User related (e.g. `Teacher`, `Student`) collections?
|
||||
A: yes
|
||||
|
||||
Q: Shall I verify `import` or `types` when do modification job ?
|
||||
A: No, you just replace the name of the function, variables etc is ok. no need to check for dependencies thanks.
|
||||
|
||||
Q: how to list files with `.tsx.draft` extensions in `src/db/UserMetas` folder?
|
||||
A: using command like `find src/db/UserMetas -name "*.tsx.draft" -type f -ls` to list the files with `.tsx.draft` extendions only exist in `src/db/UserMetas`
|
||||
|
||||
Q: when user want to modify `.tsx.draft` file, do i need to take care the `.tsx` file as well?
|
||||
A: No, no don't need to, user will handle the remaining modifications. please restrict your modification in the mentioned file or directory only.
|
0
98_AI_workspace/testing-engineer/index.md
Normal file
0
98_AI_workspace/testing-engineer/index.md
Normal file
Reference in New Issue
Block a user