Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
156 lines (120 loc) · 4.22 KB

CONTRIBUTING.md

File metadata and controls

156 lines (120 loc) · 4.22 KB

Contributing to DocPilot 🩺

Thank you for your interest in contributing to DocPilot! We welcome contributions from developers, healthcare professionals, and anyone passionate about improving healthcare technology.

🚀 Getting Started

Prerequisites

Before you begin contributing, please ensure you have:

  • Flutter SDK installed (see Setup Guide)
  • Git for version control
  • A GitHub account
  • Basic knowledge of Dart and Flutter

Development Setup

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/xkaper001/DocPilot.git
cd DocPilot
  3. Follow the Setup Instructions to get the project running
  4. Create a new branch for your feature: 
    git checkout -b feature/your-feature-name

💡 How to Contribute

🐛 Reporting Bugs

  • Check if the bug has already been reported in Issues
  • If not, create a new issue with:
    • Clear description of the problem
    • Steps to reproduce
    • Expected vs actual behavior
    • Screenshots/logs if applicable
    • Device/platform information

🚀 Suggesting Features

  • Check existing Issues for similar requests
  • Create a new issue with:
    • Clear description of the feature
    • Use case and benefits
    • Any relevant mockups or examples

🔧 Code Contributions

Pull Request Process

  1. Ensure your code follows the project's coding standards
  2. Add/update tests for your changes
  3. Update documentation as needed
  4. Run the full test suite and ensure all tests pass
  5. Create a pull request with:
    • Clear title and description
    • Reference to related issues
    • Screenshots for UI changes

Coding Standards

  • Follow Dart Style Guide
  • Use meaningful variable and function names
  • Write clear comments for complex logic
  • Maintain consistent formatting (use dart format)

Commit Messages

Use conventional commit format:

type(scope): description

[optional body]

[optional footer]

Types: feat, fix, docs, style, refactor, test, chore

Examples:

  • feat(transcription): add Deepgram integration
  • fix(ui): resolve calendar display issue
  • docs(readme): update setup instructions

🧪 Testing

Running Tests

# Run all tests
flutter test

# Run tests with coverage
flutter test --coverage

Writing Tests

  • Write unit tests for business logic
  • Write widget tests for UI components
  • Follow existing test patterns in the project
  • Aim for good test coverage

📋 Code Review Process

  1. All submissions require review before merging
  2. Reviewers will check for:
    • Code quality and adherence to standards
    • Test coverage
    • Documentation updates
    • Security considerations
  3. Address review feedback promptly
  4. Be open to suggestions and improvements

🎯 Areas for Contribution

We especially welcome contributions in:

🏥 Healthcare Features

  • Medical terminology improvements
  • HIPAA compliance enhancements
  • Integration with medical standards

🤖 AI/ML Improvements

  • Enhanced transcription accuracy
  • Better medical data extraction
  • Improved prescription generation

🎨 UI/UX Enhancements

  • Accessibility improvements
  • Mobile responsiveness
  • User experience optimizations

🔒 Security & Privacy

  • Security audits
  • Privacy enhancements
  • Compliance improvements

📚 Documentation

  • Code documentation
  • User guides
  • API documentation

🌍 Community Guidelines

  • Be respectful and inclusive
  • Help others learn and grow
  • Provide constructive feedback
  • Follow our Code of Conduct

📞 Getting Help

📜 License

By contributing to DocPilot, you agree that your contributions will be licensed under the same license as the project.

Thank you for helping make DocPilot better! Every contribution, no matter how small, makes a difference in improving healthcare technology. 🙏