Medly is open to contributions. This guide gets you from zero to contributing in minutes.
# Fork and clone
git clone https://github.com/your-username/Medly.git
cd Medly
# Install
npm install
# Environment
cp .env.example .env.local
# Add your API keys to .env.local
# Run
npm run dev| Branch | Purpose |
|---|---|
main |
Production-ready code |
develop |
Integration branch |
feature/* |
New features |
bugfix/* |
Bug fixes |
hotfix/* |
Critical fixes |
type(scope): description
feat(ai): add symptom pattern detection
fix(ui): resolve mobile layout issue
docs(readme): update quick start guide
| Type | When |
|---|---|
feat |
New feature |
fix |
Bug fix |
docs |
Documentation |
refactor |
Code cleanup |
test |
Tests |
chore |
Build/dependencies |
- TypeScript — strict mode, no
any - Prettier — auto-formatting enforced
- ESLint — must pass before PR
- Functional components — hooks only, no class components
- Error boundaries — required on all async operations
npm test # Run all tests
npm run test:watch # Watch mode
npm run test:coverage # Coverage report- Test your changes thoroughly
- Ensure all tests pass —
npm test - Lint your code —
npm run lint - Type check —
npm run type-check - Open PR against
developnotmain
PR description must include:
- What changed and why
- How to test it
- Screenshots if UI changed
Open an issue on GitHub with:
- Clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Browser + OS + version
- Screenshots if applicable
Open an issue on GitHub with:
- What problem it solves
- Proposed solution
- Alternatives considered
Never commit API keys or secrets. Use environment variables always.
For security vulnerabilities — open a private GitHub issue. Do not post publicly.
- GitHub Issues — bugs and features
- GitHub Discussions — general questions
By contributing, you agree your contributions are licensed under the same MIT License as this project.
Every contribution helps make healthcare more intelligent for everyone.