-
Notifications
You must be signed in to change notification settings - Fork 21
Description
Description:
As discussed in our recent working group meeting, the current README.md
lacks clarity, especially for new contributors. It does not clearly convey the scope, structure, or limitations of the project and its sub-components.
Proposed Improvements:
-
Clarify Project Scope & Purpose
Clearly outline what the project does, including which components (Android Client, Data Scraping, Mifos Mobile etc.) are currently functional or in development. -
Add File Structure Overview
Include a high-level breakdown of the project directory:├── Android Client/ # What it does and how can we improve. ├── Data Scraping/ ├── Mifos Mobile/ ├── Repo Clone Automation
-
List Subproject Limitations
Provide a minimal description of current known limitations for eachcommunity-ai/tree/main/
-
Suggest Future Work
Mention what's next to focus on based on priority (e.g. improving fallback logic, adding unit tests).
Expected Outcome:
A contributor-friendly README that:
- Defines what the project is
- Shows how it's organized
- Clarifies current capabilities and limitations
- Helps guide future development efforts