Appearance
Project Priorities and Status Guidelines
This document outlines the guidelines for checking project priorities and status before starting any work on the Family Shapes project.
Key Guidelines
- Always check project status before starting work
- Focus on immediate priorities first
- Align work with the current development phase
- Verify changes don't conflict with recent updates
Required Status Checks
Before starting any work, developers and contributors must:
Review the CHANGELOG.md
- Understand recent changes to avoid duplicating work
- Check for related features or fixes that might impact your task
- Note any breaking changes or deprecations
Review the ROADMAP.md
- Start with the "Immediate Priorities" section to identify the most urgent tasks
- Check the "Key Milestones" table to understand the project timeline
- Verify which phase of development is currently active
- Understand dependencies between features
Verify alignment with current phase
- Ensure your proposed changes align with the current development phase
- Check if your task is listed in the immediate priorities
- Understand how your work fits into the broader project roadmap
Prioritization Guidelines
When multiple tasks are available, prioritize work in this order:
- Tasks listed in the "Immediate Priorities" section of ROADMAP.md
- High-priority (🔴) tasks in the current development phase
- Medium-priority (🟡) tasks in the current development phase
- Low-priority (🟢) tasks in the current development phase
- Tasks in upcoming development phases (only if explicitly requested)
Implementation Approach
When implementing features or fixes:
Check for dependencies
- Verify if your task depends on other tasks being completed first
- Note any tasks that depend on your work
Follow milestone guidelines
- Adhere to the implementation approach specified for the current milestone
- Use the technologies and patterns established for the current phase
Document your work
- Update the CHANGELOG.md with your changes
- Ensure documentation reflects the current state of the project
Integration with Other Guidelines
These priority guidelines work in conjunction with:
Roadmap Structure
The project roadmap at /ROADMAP.md follows these principles:
- Immediate Priorities: Clear section at the top highlighting the most urgent tasks
- Phase Organization: Development organized into clear phases
- Timeline Indicators: Approximate timeframes for each phase
- Status Tracking: Current status of each planned feature
- Priority Levels: Clear indication of feature priorities
- Dependency Mapping: Dependencies between features
- Key Milestones: Table showing major project milestones and their status
Changelog Structure
The project changelog at /CHANGELOG.md follows these principles:
- Chronological Order: Most recent changes at the top
- Version Grouping: Changes grouped by version number
- Type Categorization: Changes categorized as:
Added: New featuresChanged: Changes to existing functionalityDeprecated: Features that will be removedRemoved: Features that were removedFixed: Bug fixesSecurity: Security-related changes
- Date Tracking: Each version includes its release date
- Reference Links: Links to relevant issues, PRs, or documentation