Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
161 lines (117 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

161 lines (117 loc) · 3.75 KB

Contributing to SyncVault

Thank you for your interest in contributing to SyncVault! This document provides guidelines and instructions for contributing to the project.

Code of Conduct

  • Be respectful and considerate in your interactions
  • Focus on constructive feedback
  • Help create a welcoming environment for all contributors

Getting Started

Prerequisites

  • Flutter SDK >= 3.35.0
  • Dart SDK >= 3.9.0
  • Git
  • A code editor (VS Code or Android Studio recommended)

Development Setup

  1. Fork the repository on GitHub

  2. Clone your forked repository:

git clone https://github.com/<your_name>/SyncVault.git
cd SyncVault
  1. Install dependencies:
flutter pub get
  1. Run the app to verify setup:
flutter run

Development Workflow

1. Keep Your Fork Updated

Always sync with the upstream repository before starting work:

git checkout master
git pull upstream master
git push origin master

2. Create a Feature Branch

Create a new branch for your work. Use descriptive names with appropriate prefixes:

  • feat/ or feature/ - New features
  • fix/ or bugfix/ - Bug fixes
  • docs/ - Documentation changes
  • refactor/ - Code refactoring
  • test/ - Test additions or changes
  • chore/ - Build process or auxiliary tool changes

Example:

git checkout -b feat/add-dropbox-support

3. Make Your Changes

  • Write clean, readable code
  • Follow existing code style and conventions
  • Add comments for complex logic
  • Update documentation as needed
  • Add tests for new functionality

4. Code Quality

Before committing, ensure your code passes all checks:

# Format code
dart format .

# Analyze code
dart analyze

# Run tests
flutter test

There are CI/CD workflows in place that check linting and formatting and will fail if these local checks also fail.

5. Commit Your Changes

Write clear, concise commit messages following these guidelines:

  • Use present tense ("Add feature" not "Added feature")
  • Use imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit first line to 72 characters
  • Reference issues and pull requests when relevant

Example:

git add .
git commit -m "feat: add Dropbox integration for file sync
- Implement Dropbox OAuth2 authentication
- Add file upload/download methods
- Update UI to show Dropbox as provider option
Fixes #123"

6. Push and Create Pull Request

git push -u origin feat/add-dropbox-support

Then on GitHub:

  1. Navigate to your fork
  2. Click "Compare & pull request"
  3. Ensure you're comparing your feature branch to upstream/master
  4. Fill in the PR template with:
    • Clear title summarizing the change
    • Description of what changed and why
    • Link to related issues
    • Screenshots for UI changes
    • Any breaking changes or migration notes

7. Code Review

  • Respond to feedback constructively
  • Make requested changes in new commits
  • Once approved, a maintainer will merge your PR

Coding Standards

Dart/Flutter

  • Follow Effective Dart guidelines
  • Use single quotes for strings
  • Prefer const constructors where possible
  • Use meaningful variable and function names
  • Keep functions small and focused on a single task

Project-Specific Guidelines

  • Use fpdart for functional error handling (Either, Option, TaskEither)
  • Use freezed for immutable data classes
  • Use riverpod for state management
  • Log errors appropriately using the error logging system
  • Add dartdoc comments to public APIs

Testing

  • Write unit tests for business logic
  • Write widget tests for UI components
  • Ensure tests are deterministic and independent
  • Place tests in the test/ directory mirroring lib/ structure

Thank you for contributing to SyncVault!