Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (65 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

88 lines (65 loc) · 2.61 KB
Raw

Contributing to CalmConnect

Thank you for your interest in contributing to CalmConnect! This mental health support app was developed during the Hack O'Gravity hackathon, and we welcome contributions that help improve mental health resources and peer support.

🎯 Project Mission

CalmConnect aims to provide accessible mental health support through:

  • Peer-to-peer and peet to conselor communication
  • Professional resource discovery
  • Daily wellness tips and self-care tools
  • Safe, supportive community building

🛠️ Development Setup

Prerequisites

  • Flutter SDK (latest stable)
  • Dart SDK
  • Android Studio / VS Code
  • Firebase CLI
  • Git

Local Setup

  1. Fork and clone the repository
  2. Install dependencies: flutter pub get
  3. Set up Firebase configuration (see README.md)
  4. Run the app: flutter run

📝 Contribution Guidelines

Code Style

  • Follow Dart/Flutter conventions
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Follow the existing GetX architecture patterns

Commit Messages

Use conventional commit format:

  • feat: add new self-care tip feature
  • fix: resolve chat message ordering issue
  • docs: update README with installation steps
  • refactor: improve authentication controller

Pull Request Process

  1. Create a feature branch: git checkout -b feature/your-feature-name
  2. Make your changes following the code style
  3. Test your changes thoroughly
  4. Update documentation if needed
  5. Submit a pull request with clear description

Areas We Need Help

  • 🎨 UI/UX improvements
  • 🔒 Security enhancements
  • 📱 Mobile accessibility features
  • 🌐 Internationalization (i18n)
  • 🧪 Unit and integration tests
  • 📚 Documentation improvements

🤝 Community Guidelines

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Remember this is a mental health app - be mindful of sensitive topics
  • Help create a safe, supportive environment

🐛 Bug Reports

When reporting bugs, please include:

  • Flutter/Dart version
  • Device/platform information
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable

💡 Feature Requests

We welcome feature suggestions that align with our mental health support mission. Please check existing issues before creating new ones.

📜 Code of Conduct

This project follows a Code of Conduct to ensure a welcoming environment for all contributors. Be kind, respectful, and supportive - just like the app we're building!

🙋‍♀️ Questions?

Feel free to open an issue for questions or reach out to the maintainers.

Built with ❤️ during Hack O'Gravity 2025