Contributing Guide

Dart/Flutter Conventions

• Follow Effective Dart style guide
• Use lowerCamelCase for variables and methods
• Use UpperCamelCase for classes
• Use snake_case for file names
• Always use const constructors when possible
• Prefer final over var when variable won't change

Code Organization

• Keep files under 500 lines when possible
• One class per file (with exceptions for small helper classes)
• Group imports: dart libraries, package imports, relative imports
• Use meaningful variable and function names
• Add comments for complex logic

Example Code Style

// Good ✅
class AnimeService {
  final ApiClient _apiClient;
  
  const AnimeService(this._apiClient);
  
  Future<List<Anime>> fetchAnimeList({
    required String userId,
    int page = 1,
  }) async {
    try {
      final response = await _apiClient.query(query);
      return response.map((e) => Anime.fromJson(e)).toList();
    } catch (e) {
      throw ApiException('Failed to fetch anime list: $e');
    }
  }
}

// Bad ❌
class anime_service {
  var apiClient;
  
  anime_service(this.apiClient);
  
  fetchAnimeList(userId, page) async {
    var response = await apiClient.query(query);
    return response.map((e) => Anime.fromJson(e)).toList();
  }
}

Before Starting

• Check if there's an existing issue or discussion about the feature
• Create a new issue to discuss major features before implementing
• Make sure the feature aligns with project goals
• Review existing similar features for consistency

Feature Structure

lib/features/your_feature/
├── data/
│   ├── models/          # Data models
│   ├── repositories/    # Data repositories
│   └── services/        # API services
├── presentation/
│   ├── pages/           # UI pages
│   ├── widgets/         # Feature-specific widgets
│   └── providers/       # State management
└── domain/
    └── usecases/        # Business logic

State Management

MiyoList uses Riverpod for state management:

final animeListProvider = FutureProvider.autoDispose
    .family<List<Anime>, String>((ref, userId) async {
  final service = ref.read(animeServiceProvider);
  return service.fetchAnimeList(userId: userId);
});

Unit Tests

• Test business logic and data models
• Mock external dependencies
• Aim for 80%+ code coverage

test('Anime.fromJson creates valid object', () {
  final json = {'id': 1, 'title': 'Test Anime'};
  final anime = Anime.fromJson(json);
  
  expect(anime.id, 1);
  expect(anime.title, 'Test Anime');
});

Widget Tests

• Test UI components and interactions
• Verify correct rendering
• Test user input handling

Running Tests

# Run all tests
flutter test

# Run specific test file
flutter test test/features/anime/anime_test.dart

# Run with coverage
flutter test --coverage

PR Checklist

• ✅ Code follows project style guidelines
• ✅ All tests pass locally
• ✅ New code is covered by tests
• ✅ Documentation is updated
• ✅ Commit messages are clear and descriptive
• ✅ PR description explains changes and motivation
• ✅ No merge conflicts with main branch

PR Title Format

type(scope): brief description

Examples:
feat(anime): add advanced filtering options
fix(auth): resolve OAuth redirect issue
docs(readme): update installation instructions
refactor(search): improve query performance
test(manga): add unit tests for MangaService

Types

• feat - New feature
• fix - Bug fix
• docs - Documentation changes
• style - Code style changes (formatting, etc.)
• refactor - Code refactoring
• test - Adding or updating tests
• chore - Maintenance tasks