34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
# Session Recording Procedure
|
|
|
|
1. The session info is stored in the /session.md file.
|
|
2. The session is recorded in chronological order, append entries to the end of
|
|
the file.
|
|
3. You will add your session summary to the `session.md` file at the end of the
|
|
file.
|
|
4. After adding your session summary. You will TRIM the summary file, if the
|
|
following conditions are met:
|
|
- The summary file is more than 1000 lines long. When trimming, you will
|
|
remove the oldest entries until the file is less than 1000 lines long.
|
|
|
|
# How to Record a Session
|
|
|
|
Record a summary of the tasks you just performed to the `session.md`. This
|
|
should be a high level summary to inform the user of the changes made. Include
|
|
any relevant context or details that would help the user understand the
|
|
modifications.
|
|
|
|
# Summary Template
|
|
|
|
The summary must follow this very simple template
|
|
|
|
## <title> - <date>
|
|
|
|
<summary>
|
|
|
|
### For example:
|
|
|
|
## Add new endpoint /help - 2023-10-05-10:00
|
|
|
|
Updated the backend to include a new `/help` endpoint that provides assistance
|
|
with common issues. This endpoint is now accessible via the main application
|
|
interface. |