crewrig

CrewRig — Agent Working Rules

This document defines the rules and conventions that all agents (human or AI) must follow when contributing to this project.

Language

All project content (code, comments, documentation, commits, issues, PRs) must be written in English.

Exception: Interpersonal interactions between the user and the agent (chat sessions) MUST be conducted in the User Preferred Language.

Branching Strategy

• The primary branch is main, linked to the origin remote (GitHub).
• The main branch is protected: no direct pushes allowed.
• Every change must go through a feature branch merged into main via a Pull Request.
• NEVER merge a Pull Request (PR/MR) without asking for the user’s formal permission JUST BEFORE executing the merge.
• The import/gitlab branch tracks the legacy GitLab project (gitlab remote) and serves as inspiration only.

Commit Convention

All commits must follow the Gitmoji convention.

Format: <emoji> <Short description>

Examples:

• 🎉 Initial commit
• ✨ Add user authentication module
• 🐛 Fix null pointer in config loader
• 📝 Update README with setup instructions
• ♻️ Refactor settings parser for clarity

Refer to gitmoji.dev for the full list of valid emojis and their meanings.

Pull Request Format

Every PR must follow this structure:

Title

A concise, descriptive title.

Body

<Two sentences maximum explaining the purpose of this PR for a human reader.>

## How to read this PR?

<A reading guide to help reviewers navigate the changeset. Highlight key files,
the order in which to read them, and any non-obvious design decisions.>

## How to test this PR?

<Step-by-step instructions to test the proposed changes locally.
Include prerequisites, commands to run, and expected outcomes.>

## Detailed description (for agents)

<A thorough, structured description of every change made in this PR.
This section is intended for AI agents that will analyze the PR.
Be explicit about what was added, modified, or removed and why.>

Logbook Issues

Every PR must be linked to a logbook issue on GitHub.

A logbook issue is a detailed journal entry that traces:

• Every obstacle encountered and the resolution or avoidance strategy applied
• Every challenge faced during implementation
• Every success and breakthrough

This strategy ensures that all experience (failures and successes) from agents working on the project is recorded and available for future reference.

Logbook issues must be written in English and use the label logbook.

GitHub Access

All GitHub operations (PRs, issues, branch protection) are performed through the dedicated MCP server.

This site is open source. Improve this page.