feat: add documentation rules and project paths; implement display priority management in code
This commit is contained in:
1 parent
b78f34c1d3
commit
1c19413970
10 files changed
+222
-66
No files matched your search
@@ -0,0 +1,9 @@
|
||||
# Dokumentations-Regeln für Code-Projekte
|
||||
|
||||
## Handbuch und Dokumentation
|
||||
Achte bitte darauf, dass du mit der aktualisierung von openmemory auch die Dokumentation und Endanwender-Handbuch
|
||||
mit aktualisierst, wenn es neue Funktionen für Nutzer gibt.
|
||||
- path for documentation and user manual: ~/dev/FilaMan/FilaMan-System-docu/
|
||||
|
||||
## Readme
|
||||
Halte bitte außerdem auch die Readme Files im Repo aktuell.
|
||||
@@ -0,0 +1,5 @@
|
||||
# Nutzung von MCP Servern
|
||||
|
||||
### Nutze bitte möglichst immer die bereitgestellten MCP Server.
|
||||
- Um die Codebasis zu erforschen, nutze jcodemunch-mcp
|
||||
- Für Coding an sich, nutze context7
|
||||
@@ -0,0 +1,44 @@
|
||||
**# OpenMemory Rules for Code Projects**
|
||||
|
||||
- Use the OpenMemory/Memory tools whenever possible to store and retrieve important project knowledge.
|
||||
- search openmemory before you inspect folders and files
|
||||
- Goal: decisions, code changes, and bug fixes should be saved in a way that they can be reused in new sessions.
|
||||
|
||||
**## When Something Should Be Stored**
|
||||
|
||||
- **After every major code change**
|
||||
- Create a brief memory note with:
|
||||
- Affected files/modules
|
||||
- What was changed?
|
||||
- Why was it changed? (goal / requirements)
|
||||
- Potential risks or TODOs
|
||||
- **For every decision** (API design, architecture, important trade‑offs)
|
||||
- Create a memory note of type “Decision” with:
|
||||
- Context / problem
|
||||
- Considered options
|
||||
- Chosen option
|
||||
- Justification
|
||||
- **For every bug fix**
|
||||
- Create a memory note of type “Bugfix” with:
|
||||
- Symptom / error picture (e.g., error message)
|
||||
- Cause
|
||||
- Fix (which files/lines)
|
||||
- What to note for the future
|
||||
|
||||
**## How Memories Should Be Structured**
|
||||
|
||||
- Use consistent project tags, e.g., `project:my-project`.
|
||||
- Use type tags like `type:decision`, `type:change`, `type:bugfix`.
|
||||
- If possible, link commits or exact file paths / line numbers in the note.
|
||||
|
||||
**## Usage in New Sessions or Tasks**
|
||||
|
||||
- At the start of a new session or task:
|
||||
- Load the most important OpenMemory entries for the current project (e.g., last decisions, relevant bug fixes).
|
||||
- Create a short overview for yourself before new suggestions are made.
|
||||
- If a new error occurs:
|
||||
- First check OpenMemory for previous similar errors, relevant changes or decisions before re‑analyzing the code or making a new decision.
|
||||
|
||||
**# Git Rules**
|
||||
|
||||
- **NEVER** push independently to a git repository/branch!
|
||||
@@ -0,0 +1,14 @@
|
||||
# rules for the FilaMan project
|
||||
|
||||
## path
|
||||
- path for project: ~/dev/FilaMan/FilaMan-System-opencode
|
||||
- path for project documentation and user manuel: ~/dev/FilaMan/FilaMan-System-docu
|
||||
- path for Bambulab Local-Communication Plugin: ~/dev/FilaMan/FilaMan-BambuLab-Plugin
|
||||
- path for BambuLab Cloud-Communication Plugin: ~/dev/FilaMan/FilaMan-BambuLabCloud-Plugin
|
||||
- path for SpoolmanDB Impoft Plugin: ~/Users/manuel~/dev/FilaMan/FilaMan-SpoolmanDB-Plugin
|
||||
- path for SpoolmanAPI Plugin: ~/Users/manuel~/dev/FilaMan/FilaMan-SpoolmanAPI-Plugin
|
||||
|
||||
## User Version Info: changelog.json
|
||||
- File: frontend/src/changelog.json
|
||||
- Inhalt: eine Userfreundeliche Information über Neuerungen, Änderungen oder Entfernte Funktionen für den User. Keine technischen Details oder ähnliches, Kurz und pregnant.
|
||||
- Als Platzhalter für die Version wird "UNRELEASED" genutzt. Dieser wird beim bump im Workflow ersetzt.
|
||||
Reference in new issue
Block a user