Skip to content

Add comprehensive README.md with known issues and contribution guidelines#1

Merged
shafisma merged 2 commits intomainfrom
copilot/add-readme-file
Jan 15, 2026
Merged

Add comprehensive README.md with known issues and contribution guidelines#1
shafisma merged 2 commits intomainfrom
copilot/add-readme-file

Conversation

Copy link
Contributor

Copilot AI commented Jan 15, 2026

Replaced generic Flutter template README with production-ready documentation. Explicitly documents that SMS transaction parsing is non-functional and invites contributions.

Changes

  • Project overview: Description of Finenzo as smart expense tracker with feature list (multi-wallet, analytics, biometric security, CSV/PDF/Excel export)
  • Setup instructions: Prerequisites, dependencies, build_runner workflow for Drift database generation
  • Technology stack: Flutter 3.8.1, Provider, Drift (SQLite), telephony, fl_chart, local_auth
  • Known Issues section: SMS transaction parsing marked as broken - inconsistent format parsing, limited bank pattern support, Android version reliability issues
  • Contributing section: Fork/PR workflow, priority areas (SMS parsing, internationalization, bank support, iOS, testing), development guidelines

Key Section

## ⚠️ Known Issues

### Message Transaction Feature
The SMS transaction parsing feature is currently **not working as expected**. While the app can read SMS messages and attempt to parse transaction details from mobile money services, there are known issues with:
- Inconsistent SMS format parsing
- Limited pattern matching for various banks and services
- Reliability issues on different Android versions

We are aware of this limitation and are working to improve it. **Contributions are welcome!**
Original prompt

Add readme.md for this project. mention the fact that message transaction feature doesn't work and contributions are welcome


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…delines

Co-authored-by: shafisma <113597196+shafisma@users.noreply.github.com>
Copilot AI changed the title [WIP] Add README.md to project with notes on message transaction feature Add comprehensive README.md with known issues and contribution guidelines Jan 15, 2026
Copilot AI requested a review from shafisma January 15, 2026 09:58
@shafisma shafisma marked this pull request as ready for review January 15, 2026 10:02
@shafisma shafisma merged commit 588b3c0 into main Jan 15, 2026
1 check passed
@shafisma shafisma deleted the copilot/add-readme-file branch January 15, 2026 10:03
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.

2 participants