Project Definitions Guide
🚦 Definition of Ready (DoR)
Before a task can be started, it must meet our DoR criteria. This ensures clarity and that all tasks started have been sufficiently prepared.
Criteria:
- Description Clarity: Every task must have a clear and concise description, preferably using the Gherkin language.
- Prioritized Ticket: The importance and order of the task should be established.
- Jira Version Identified: The version or sprint in Jira should be set.
- Workshops: Before implementing, the developer should organize a workshop with the PM to ensure clarity. Document workshop decisions in JIRA comments.
- Subtasks: Ensure all development is related to a subtask, never directly to a US, TS, or Bug.
- Estimated: Only Subtasks should be estimated. They should be between 2-3 days. If more, reconsider its scope.
- Assigned Owner: There must be a designated responsible individual for the task.
- Acceptance Criteria: Acceptance Criteria must be defined
- Dependencies: Dependencies must be resolved
🏁 Definition of Done (DoD)
Meeting the DoD ensures that our tasks maintain a consistent quality and that nothing is marked complete prematurely.
Criteria:
- Unit Tests: All unit tests associated with the task should pass 100%.
- Code Review: The code should be reviewed by a peer or a team lead ( the MR must respect the Conventional Commit standard ).
- Code Merged: Completed code should be merged into the Staging branch. (If applicable)
- Proofs: Add a comment in each task (US, TS, Bug) describing the work done or providing proof of development.
- Delivery + CI: The delivery tested by QA must come from the CI.
- QA Test: Quality assurance testing should be completed and successful.
- Technical Documentation: If applicable, the technical documentation should be updated ( all documentation must be versioned in git ).
- Feedback Incorporation: All outputs/discussions from workshops should be incorporated and noted in subtask comments.
danger
Every commit should adhere to the Conventional Commit standard. This ensures clarity and a useful git history.