- Introduction
- Pitch
- Hogwarts
- Live Demo
- MVP
- Roadmap
- Launch Sprint
- PRD
- Get Started
- Localhost
- Architecture
- Structure
- Pattern
- Page
- Layout
- Content
- Types
- Config
- Actions
- Queries
- Authorization
- Validation
- Form
- Table
- Detail
- Card
- Util
- Hooks
- List Params
- Views
- README.md
- ISSUE.md
- Technology Stack
- Database
- File
- CDN Assets
- Entry Points
- Dashboard
- Authentication
- Credentials
- OAuth
- Flow Diagrams
- Multi-Tenancy
- Offline
- Onboarding
- Onboarding Videos
- Add Values
- Admission
- Application
- Attendance
- Compliance
- Profile
- Exams
- Exam Wizard
- Timetable
- Classrooms
- Notifications
- Conference
- LMS (Lumos)
- Finance
- Fee Management
- Invoice
- Wallet
- Salary
- Payroll
- Timesheet
- Expenses
- Budget
- Receipt
- Accounts
- Banking
- Reports
- Dashboard
- Permissions
- Messages
- Integration Flow
- Provision
- AI Document Processing
- Document Intelligence
- Internationalization
- Translation
- Translation Guide
- Icons
- Docs Factory
- Inspiration
- Listings
- Teachers
- Students
- Catalog
- Library
- Contributing
- Code of conduct
- GitHub Workflow
- Database Seeds
- Database Safety
- Test Accounts
- Playwright
- Prettier
- Block Rebound
We pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity, experience, education, socio-economic status, nationality, appearance, race, caste, color, religion, or sexual orientation.
We act in ways that contribute to an open, welcoming, diverse, inclusive, healthy community.
Standards
Positive behavior
- Empathy and kindness toward others.
- Respect for differing opinions, viewpoints, experiences.
- Giving and gracefully accepting constructive feedback.
- Accepting responsibility, apologising, learning from mistakes.
- Focusing on what is best for the community.
- Welcoming and inclusive language.
Unacceptable behavior
- Sexualised language or imagery; sexual attention or advances.
- Trolling, insulting or derogatory comments, personal or political attacks.
- Public or private harassment.
- Publishing others' private information without permission.
- Other conduct that could reasonably be considered inappropriate in a professional setting.
Principles
We are a small, fast-moving team building school automation for Sudan and the wider MEA region.
- Respect first — assume positive intent; critique ideas, not people.
- Users over egos — the school experience is our north star.
- Bias to ship — iterate weekly with small, reversible changes.
- Ownership — see issues through to resolution.
- Transparency — async-first; write it down.
Scope
This Code applies in all community spaces:
- GitHub repositories (issues, PRs, discussions, code reviews).
- Discord server and DMs.
- Documentation and code comments.
- Project events (virtual or in person).
It also applies when an individual officially represents the community in public.
Reporting
If you experience or witness unacceptable behavior:
| Channel | Use |
|---|---|
| Tech Lead directly (confidential) | |
| Discord | DM a maintainer |
| GitHub | Private security advisory if code-related |
Reports are reviewed promptly and kept confidential. You'll receive acknowledgment within 48 hours.
Enforcement
Community leaders clarify and enforce standards. They have the right to remove, edit, or reject contributions that don't align, and will explain moderation decisions when appropriate.
| Stage | Impact | Consequence |
|---|---|---|
| 1. Correction | Inappropriate or unwelcome behavior | Private written warning explaining the violation; public apology may be requested |
| 2. Warning | A single incident or series | Warning + no interaction with affected parties for a set period |
| 3. Temporary ban | Serious or sustained violation | Temporary ban from interaction; violations escalate |
| 4. Permanent ban | Pattern of violation, harassment, or aggression | Permanent removal from community |
Attribution
Adapted from the Contributor Covenant, version 2.1. Enforcement guidelines inspired by Mozilla's enforcement ladder.