docs: add collaboration guide and AGENTS.md files for knowledge-base and daily
This commit is contained in:
Vivek
parent
c9b277324b
commit
5f18e74989
3 changed files with 142 additions and 0 deletions
40
daily/AGENTS.md
Normal file
40
daily/AGENTS.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# Daily Log — Agent Collaboration Guide
|
||||
|
||||
## Purpose
|
||||
Store short daily observations, tasks completed, blockers, and ideas that don’t warrant a full research note.
|
||||
|
||||
## File Naming
|
||||
`YYYY-MM-DD-log.md` (e.g., `2026-06-11-log.md`)
|
||||
|
||||
## Required Front-Matter
|
||||
```yaml
|
||||
---
|
||||
title: "YYYY-MM-DD Daily Log"
|
||||
date: YYYY-MM-DD
|
||||
tags: ["#daily-log"]
|
||||
status: published
|
||||
---
|
||||
```
|
||||
|
||||
## Structure
|
||||
- **Tasks Done** – bullet list of completed items
|
||||
- **Notes** – any insights, links, or observations
|
||||
- **Blockers** – what prevented progress and possible solutions
|
||||
- **Next Actions** – prioritized list for tomorrow
|
||||
|
||||
## Example
|
||||
```markdown
|
||||
## Tasks Done
|
||||
- Cloned morpheus-brain repo
|
||||
- Added Forgejo URL migration study
|
||||
|
||||
## Notes
|
||||
- Other agents may be working on the same repo; always `git pull` before editing.
|
||||
|
||||
## Blockers
|
||||
- Need to confirm CI hook for push validation.
|
||||
|
||||
## Next Actions
|
||||
- Create the `ci-pre-push.sh` script
|
||||
- Add `knowledge-base/AGENTS.md`
|
||||
```
|
||||
41
knowledge-base/AGENTS.md
Normal file
41
knowledge-base/AGENTS.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# Knowledge-Base — Agent Collaboration Guide
|
||||
|
||||
## Purpose
|
||||
Curated insights distilled from `research/`, daily logs, and cross-agent contributions. This is the “source of truth” that other agents should consult before making architectural decisions.
|
||||
|
||||
## File Naming
|
||||
Descriptive, lowercase filenames with `.md` extension:
|
||||
- `morpheus-identity.md`
|
||||
- `forgejo-migration-checklist.md`
|
||||
- `<topic>-overview.md`
|
||||
|
||||
## Front-Matter Template
|
||||
```yaml
|
||||
---
|
||||
title: "<human readable title>"
|
||||
date: YYYY-MM-DD
|
||||
tags: ["#knowledge-base", "#topic-tag"]
|
||||
status: published
|
||||
related:
|
||||
- ../research/tech-study/2026-06-11-forgejo-url-change.md
|
||||
- ../daily/2026-06-11-log.md
|
||||
---
|
||||
```
|
||||
|
||||
## Workflow
|
||||
1. **Read existing entries** before adding new ones to avoid duplication.
|
||||
2. **Synthesize** findings from `research/` or `daily/` into a distilled summary.
|
||||
3. **Link back** to source files using the `related` field.
|
||||
4. **Mark status** as `draft`, `review`, or `published`.
|
||||
5. **Add an entry** to `index.md` with a one-line description and link.
|
||||
|
||||
## Example Entry
|
||||
```markdown
|
||||
# Forgejo Migration Checklist
|
||||
|
||||
Quick checklist for moving repositories from the old sslip.io instance to git.errorlog.space.
|
||||
|
||||
- [ ] Update remotes
|
||||
- [ ] Regenerate API keys
|
||||
- [ ] Update CI variables
|
||||
```
|
||||
61
knowledge-base/COLLABORATION.md
Normal file
61
knowledge-base/COLLABORATION.md
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
# Collaboration Guide for Morpheus Brain
|
||||
|
||||
## How to Fork & Contribute
|
||||
|
||||
1. **Fork the repository**
|
||||
```bash
|
||||
git clone https://git.errorlog.space/iamcoolvivek007/morpheus-brain.git
|
||||
cd morpheus-brain
|
||||
```
|
||||
|
||||
2. **Create a branch for your work**
|
||||
```bash
|
||||
git checkout -b feature/<your-initiative>
|
||||
```
|
||||
|
||||
3. **Follow the DOX pattern**
|
||||
- All folders have an `AGENTS.md` that describes file naming, tagging, and workflow.
|
||||
- Add new studies under `research/tech-study/` using the format `YYYY-MM-DD-<topic>.md`.
|
||||
- Include front‑matter (title, date, tags, status) at the top of each markdown file.
|
||||
|
||||
4. **Run the pre‑push checks**
|
||||
```bash
|
||||
./scripts/ci-pre-push.sh
|
||||
```
|
||||
|
||||
5. **Commit & push**
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "feat:<short description>"
|
||||
git push origin feature/<your-initiative>
|
||||
```
|
||||
|
||||
6. **Open a Pull Request**
|
||||
- Fill the PR template (auto‑generated by your commit message).
|
||||
- Tag the PR with relevant labels (`enhancement`, `bugfix`, `docs`).
|
||||
|
||||
7. **Address Review Comments**
|
||||
- Agents may request changes; update your branch and force‑push as needed.
|
||||
|
||||
8. **Merge**
|
||||
- After approval, merge into `main` (or let the designated maintainer merge).
|
||||
|
||||
## Communication Channels
|
||||
|
||||
- **Telegram/Discord:** Use the Hermes channel `#morpheus-brain` for announcements.
|
||||
- **Issue Tracker:** Open an issue for major proposals before starting work.
|
||||
|
||||
## Coding Standards
|
||||
|
||||
- Use 4‑space indentation.
|
||||
- Prefer markdown lists for documenting steps.
|
||||
- Keep file names lowercase with hyphens.
|
||||
- Include a `README.md` in each new subfolder describing its purpose.
|
||||
|
||||
## Versioning & Backups
|
||||
|
||||
- The `backups/` directory stores daily tar‑balls of `knowledge-base/`.
|
||||
- To restore, extract the latest backup:
|
||||
```bash
|
||||
tar -xzf backups/knowledge-backup-$(date +%Y%m%d).tar.gz -C /
|
||||
```
|
||||
Loading…
Reference in a new issue