Contributing Guidelines
Thank you for your interest in contributing to Ciyex EHR!
Code of Conduct
Please treat everyone with respect. Harassment or abusive behavior will not be tolerated.
Getting Started
- Fork the Repository: Create your own fork on GitHub.
- Clone Locally:
git clone https://github.com/YOUR_USERNAME/ciyex.git - Setup Environment: Follow the Local Setup Guide.
Development Workflow
-
Create a Branch:
git checkout -b feature/amazing-featurePrefixes:
feature/,fix/,docs/,refactor/. -
Make Changes: Write code and add tests.
-
Commit: Use clear, descriptive commit messages.
git commit -m "feat: Add telehealth waiting room" -
Push:
git push origin feature/amazing-feature -
Open Pull Request: Target the
mainbranch. Provide a description of your changes.
Code Style
Java (Backend)
- Use standard Java naming conventions.
- Checkstyle is enforced via Gradle.
./gradlew checkstyleMain
TypeScript/React (Frontend)
- Use Prettier and ESLint.
npm run lint
Definition of Done
A PR is gathered "ready" when:
- All tests pass.
- New code is covered by tests.
- Documentation is updated (if applicable).
- Linter checks pass.
Reporting Bugs
Please use the GitHub Issues tab. Include:
- Steps to reproduce
- Expected vs. actual behavior
- Screenshots/Logs