Skip to content

feat(EWM_TECH): Upgrade project documentation #902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

levitckii-daniil
Copy link
Contributor

Description

This PR significantly upgrades the project documentation to provide comprehensive guidance for developers working on the SparX Wallet Flutter application. The documentation covers all aspects of the project architecture, development workflow, and engineering processes.

Key documentation additions:

  • CLAUDE.md - Centralized guide for AI-assisted development with build commands and LLM instructions
  • Enhanced README.md - Complete project overview with architecture descriptions and quick start guides
  • Architecture documentation - Detailed Clean Architecture implementation with Elementary MVVM patterns
  • Theme system guide - Comprehensive v2 theming system, design tokens, and component library
  • Testing documentation - Complete testing strategies for Elementary architecture with Mocktail patterns
  • Process workflows - Git workflow, task management, release processes, and conventional commits

copilot:all

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

- Perform data transformation between domain and UI formats
- Handle caching and optimization logic when appropriate

In Elementary architecture, the Model serves as the "brain" that supplies the WidgetModel with processed data and execution capabilities, keeping business logic separate from presentation logic.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

На уровне Elementary - мозгом больше является WM. Так как она все координирует. Model больше как поставщик данных от внешних зависимостей.


**Key characteristics:**

- Use Freezed for immutability and pattern matching
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Думаю нужно допустить использование простых классов class Data {}.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants