Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (32 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 1.91 KB

Contributing to Turtlez

Thank you for your interest in Turtlez! We are building an agentic coding environment with infinite context, and we welcome contributions that help us reach that vision.

The "Blog Notebook" Strategy

In this project, we treat git commits and pull requests as a collaborative notebook. This is critical for our "Building in Public" strategy and helps feed our blog-writing AI agents.

Commit Message Format

While optional for quick fixes, we strongly prefer the following format for significant changes:

  1. Header: type(scope): Title (e.g., feat(ui): [Panels] Implement v2.1)
  2. Body: Acts as a mini-blog post.

Required Sections in Commit Body:

  • Story of Collaboration: What was requested? How did the iteration happen?
  • Decisions Made: Why was this specific architecture or approach chosen?
  • Challenges: What were the technical hurdles or interesting problems solved?

Example:

feat(ui): [Batch] Fix grid layouts

Story of Collaboration:
User noticed the grid looked empty with 2 items. We decided to make it adaptive.

Decisions Made:
- Implemented dynamic grid-cols based on item count to avoid whitespace.

Challenges:
- Handling CSS transitions smoothly during layout shifts.

Pull Request Guidelines

PRs should follow the same "Blog Notebook" style in their description. A good PR tells a story of why the change exists and how it evolved during development.

Development Workflow

  1. Fork the repo and create your branch from master.
  2. Install dependencies: cd rlm-chat && bun install.
  3. Run tests: Ensure all tests pass before submitting (bun run test and npx playwright test).
  4. Type safety: We enforce strict typing. Ensure tsc --noEmit passes.
  5. Linting: Ensure bun run lint passes.

Code of Conduct

Please be respectful and professional in all interactions. We are here to build cool things together!