1.6 KiB
1.6 KiB
Development Workflow
This project uses Red-Green TDD/BDD and feature-branch workflow with pull request review.
Red-Green TDD/BDD Cycle
For each behavior increment:
- Red: describe behavior with a failing specification/test.
- Green: implement the smallest change needed to satisfy behavior.
- Refactor: improve structure while keeping behavior unchanged.
BDD intent:
- Express behavior in user-meaningful terms.
- Prefer scenario-oriented acceptance criteria before implementation details.
- Keep unit and integration tests aligned with documented behavior.
Definition of done for a change:
- Behavior is specified and verified.
- Relevant tests are passing.
- Refactoring has preserved behavior.
- Documentation is updated when contracts or workflows change.
Feature-Branch Workflow
Use short-lived branches from main.
Branch pattern examples:
- feature/
- fix/
- docs/
- chore/
Branch workflow:
- Create branch from latest main.
- Commit small, reviewable increments.
- Open pull request early.
- Keep branch current with main.
- Merge after review and checks pass.
- Delete merged branch.
Pull Request Expectations
- Clear behavior statement and acceptance criteria.
- Test evidence for the behavior change.
- Notes on any architectural or moderation impact.
- Scope limited to one cohesive change.
Agent Collaboration Rules
- Agents may support test planning, scenario writing, and review checklists.
- Agents must not generate executable core project code.
- For implementation guidance, agents should link primary sources and provide paraphrased walkthroughs.