Contributing to Vaani

Welcome Contributors! 🚀

We appreciate your interest in contributing to Vaani. This guide will help you navigate the contribution process effectively.

How to Contribute

Reporting Bugs 🐞

Check Existing Issues:
- Search through the GitHub Issues
Create a Detailed Bug Report:
- Provide:
  - Exact steps to reproduce
  - Relevant error logs or screenshots

Development Workflow

Setting Up the Development Environment

Prerequisites:
- Git
- Flutter SDK
- Recommended IDE: VS Code

Repository Setup:

Fork the repo

Clone the forked repository to your local machine

   # Fork the main repository on GitHub
   git clone --recursive https://github.com/[YOUR_USERNAME]/Vaani.git
   cd Vaani

   # Initialize and update submodules
   git submodule update --init --recursive

   # Install dependencies for the main app and submodules
   flutter pub get

Coding Standards

Code Style:
- Follow Flutter's style guide
- Use dart format and flutter analyze

   dart format .
   flutter analyze

Testing:
- Write unit and widget tests
- Ensure tests pass for both the main app and submodules

   flutter test

Pull Request Process

Branch Naming:
- Use descriptive branch names
- Prefix with feature/, bugfix/, or docs/

   git checkout -b feature/add-accessibility-support

Commit Messages:
- Use clear, concise descriptions
- Reference issue numbers when applicable
- Follow conventional commits format:

<type>(scope): <description>

Pull Request Guidelines:
- Clearly describe the purpose of your changes
- Include screenshots for visual changes
- Specify if changes affect specific submodules
- Ensure all CI checks pass

Communication

Code of Conduct

Be respectful and inclusive
Constructive feedback is welcome
Collaborate and support fellow contributors

Happy Contributing! 🌟

2.4 KiB Raw Blame History