Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
268 lines (194 loc) · 6.38 KB

CONTRIBUTING.md

File metadata and controls

268 lines (194 loc) · 6.38 KB

Contributing to SpotiFLAC

First off, thank you for considering contributing to SpotiFLAC! 🎉

This document provides guidelines and steps for contributing. Following these guidelines helps maintain code quality and ensures a smooth collaboration process.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates.

When creating a bug report, please use the bug report template and include:

  • Clear and descriptive title
  • Steps to reproduce the issue
  • Expected behavior vs actual behavior
  • Screenshots or screen recordings if applicable
  • Device information (model, OS version)
  • App version
  • Logs from Settings > About > View Logs

Suggesting Features

Feature requests are welcome! Please use the feature request template and:

  • Check existing issues to avoid duplicates
  • Describe the feature clearly
  • Explain the use case - why would this be useful?
  • Consider the scope - is this a small enhancement or a major feature?

Code Contributions

  1. Fork the repository and create your branch from dev
  2. Make your changes following our coding guidelines
  3. Test your changes thoroughly
  4. Submit a pull request to the dev branch

Translations

We use Crowdin for translations. To contribute:

  1. Visit our Crowdin project
  2. Select your language or request a new one
  3. Start translating!

Translation files are located in lib/l10n/arb/.

Development Setup

Prerequisites

  • Flutter SDK 3.10.0 or higher
  • Dart SDK 3.10.0 or higher
  • Android Studio or VS Code with Flutter extensions
  • Git

Getting Started

  1. Clone your fork

    git clone https://github.com/YOUR_USERNAME/SpotiFLAC-Mobile.git
cd SpotiFLAC-Mobile

  2. Add upstream remote

    git remote add upstream https://github.com/zarzet/SpotiFLAC-Mobile.git

  3. Install dependencies

    flutter pub get

  4. Generate code (for Riverpod, JSON serialization, etc.)

    dart run build_runner build --delete-conflicting-outputs

  5. Run the app

    flutter run

Building

# Debug build
flutter build apk --debug

# Release build
flutter build apk --release

Project Structure

lib/
├── l10n/               # Localization files
│   └── arb/            # ARB translation files
├── models/             # Data models
├── providers/          # Riverpod providers
├── screens/            # UI screens
│   └── settings/       # Settings sub-screens
├── services/           # Business logic services
├── theme/              # App theming
├── utils/              # Utility functions
├── widgets/            # Reusable widgets
├── app.dart            # App configuration
└── main.dart           # Entry point

Coding Guidelines

General

  • Follow Effective Dart guidelines
  • Use meaningful variable and function names
  • Keep functions small and focused
  • Add comments for complex logic

Formatting

  • Use dart format before committing
  • Maximum line length: 80 characters
  • Use trailing commas for better formatting
dart format .

Linting

Ensure your code passes all lints:

flutter analyze

State Management

We use Riverpod for state management. Follow these patterns:

// Use code generation with riverpod_annotation
@riverpod
class MyNotifier extends _$MyNotifier {
  @override
  MyState build() => MyState();
  
  // Methods to update state
}

Localization

All user-facing strings should be localized:

// Good
Text(AppLocalizations.of(context)!.downloadComplete)

// Bad
Text('Download Complete')

To add new strings:

  1. Add the key to lib/l10n/arb/app_en.arb
  2. Run flutter gen-l10n

Commit Guidelines

We follow Conventional Commits:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Types

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

Examples

feat(download): add batch download support
fix(ui): resolve overflow on small screens
docs: update contributing guidelines
chore(deps): update flutter_riverpod to 3.1.0

Pull Request Process

  1. Update your fork

    git fetch upstream
git rebase upstream/dev

  2. Create a feature branch

    git checkout -b feat/my-new-feature

  3. Make your changes and commit following our guidelines

  4. Push to your fork

    git push origin feat/my-new-feature

  5. Create a Pull Request

    • Target the dev branch
    • Fill in the PR template
    • Link related issues

  6. Address review feedback

    • Make requested changes
    • Push additional commits
    • Request re-review when ready

PR Requirements

  • Code follows project conventions
  • All tests pass
  • No new linting errors
  • Documentation updated (if needed)
  • Commit messages follow guidelines
  • PR description is clear and complete

Questions?

If you have questions, feel free to:

Thank you for contributing! 💚