1.8 KiB
1.8 KiB
Collaboration Guide for Morpheus Brain
How to Fork & Contribute
-
Fork the repository
git clone https://git.errorlog.space/iamcoolvivek007/morpheus-brain.git cd morpheus-brain -
Create a branch for your work
git checkout -b feature/<your-initiative> -
Follow the DOX pattern
- All folders have an
AGENTS.mdthat describes file naming, tagging, and workflow. - Add new studies under
research/tech-study/using the formatYYYY-MM-DD-<topic>.md. - Include front‑matter (title, date, tags, status) at the top of each markdown file.
- All folders have an
-
Run the pre‑push checks
./scripts/ci-pre-push.sh -
Commit & push
git add . git commit -m "feat:<short description>" git push origin feature/<your-initiative> -
Open a Pull Request
- Fill the PR template (auto‑generated by your commit message).
- Tag the PR with relevant labels (
enhancement,bugfix,docs).
-
Address Review Comments
- Agents may request changes; update your branch and force‑push as needed.
-
Merge
- After approval, merge into
main(or let the designated maintainer merge).
- After approval, merge into
Communication Channels
- Telegram/Discord: Use the Hermes channel
#morpheus-brainfor 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.mdin each new subfolder describing its purpose.
Versioning & Backups
- The
backups/directory stores daily tar‑balls ofknowledge-base/. - To restore, extract the latest backup:
tar -xzf backups/knowledge-backup-$(date +%Y%m%d).tar.gz -C /