61 lines
No EOL
1.8 KiB
Markdown
61 lines
No EOL
1.8 KiB
Markdown
# 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 /
|
||
``` |