Contributing Guide

How to contribute to the Everything App — from setup to pull request.

Development Setup

1. Fork the repository on GitHub
2. Clone your fork:
   git clone https://github.com/YOUR_USERNAME/everything.git cd everything
3. Install dependencies:
   flutter pub get
4. Run tests to verify setup:
   flutter test

Development Workflow

1. Create a feature branch from master:
   git checkout -b feature/your-feature-name
2. Make your changes following the code conventions
3. Write or update tests for your changes
4. Run the full test suite:
   flutter test
5. Commit with a clear message:
   git commit -m "feat: add event export to CSV"
6. Push and open a Pull Request

Code Conventions

Architecture Rules

• Models — Pure Dart, no Flutter imports. Immutable with copyWith().
• Services — No UI imports. Coordinate between state and data layers.
• Providers — Expose UnmodifiableListView. All mutations through named methods.
• Views — No business logic. Delegate to services/providers.

Commit Messages

Use Conventional Commits:

Dart Style

• Follow Effective Dart guidelines
• Use dart format before committing
• Add doc comments (///) to all public APIs
• Use meaningful variable names — no single-letter names except loop counters

Testing Requirements

• All new models must have serialization round-trip tests
• All new services must have unit tests with mocked dependencies
• State changes (providers/blocs) must have tests verifying correct emissions
• Edge cases: empty inputs, null fields, malformed data, boundary values

Pull Request Guidelines

• Fill out the PR template (auto-generated from .github/PULL_REQUEST_TEMPLATE.md)
• Link related issues with Fixes #123 or Closes #456
• Keep PRs focused — one feature/fix per PR
• Ensure CI passes (lint + tests + coverage)
• Add screenshots for visual changes

Filing Issues

Use the appropriate issue template: