Contributing

git clone https://github.com/YOUR_USERNAME/appflowy-editor.git
cd appflowy-editor

git remote add upstream https://github.com/AppFlowy-IO/appflowy-editor.git

flutter pub get

flutter test

git checkout -b feature/your-feature-name
# or
git checkout -b fix/bug-description

# Run all tests
flutter test

# Run specific test file
flutter test test/path/to/test_file.dart

# Run tests with coverage
flutter test --coverage

git add .
git commit -m "feat: add new block component for tables"

git fetch upstream
git rebase upstream/main

git push origin feature/your-feature-name

# Format your code
dart format .

# Analyze for issues
flutter analyze

// 1. Imports (organized)
import 'dart:async';

import 'package:flutter/material.dart';

import 'package:appflowy_editor/appflowy_editor.dart';

// 2. Class declaration
class MyWidget extends StatefulWidget {
  // 3. Constructor
  const MyWidget({
    super.key,
    required this.editorState,
  });

  // 4. Public fields
  final EditorState editorState;

  // 5. Override methods
  @override
  State<MyWidget> createState() => _MyWidgetState();
}

class _MyWidgetState extends State<MyWidget> {
  // 6. Private fields
  late final EditorScrollController _scrollController;

  // 7. Lifecycle methods
  @override
  void initState() {
    super.initState();
    _scrollController = EditorScrollController(
      editorState: widget.editorState,
    );
  }

  @override
  void dispose() {
    _scrollController.dispose();
    super.dispose();
  }

  // 8. Build method
  @override
  Widget build(BuildContext context) {
    return Container();
  }

  // 9. Private helper methods
  void _helperMethod() {
    // Implementation
  }
}

import 'package:flutter_test/flutter_test.dart';
import 'package:appflowy_editor/appflowy_editor.dart';

void main() {
  group('Feature description', () {
    test('should behave as expected', () {
      // Arrange
      final editorState = EditorState.blank();
      
      // Act
      // Perform action
      
      // Assert
      expect(editorState.document.root.children.length, equals(1));
    });

    testWidgets('widget should render correctly', (tester) async {
      // Arrange
      await tester.pumpWidget(
        MaterialApp(
          home: AppFlowyEditor(
            editorState: EditorState.blank(),
          ),
        ),
      );

      // Act
      await tester.pump();

      // Assert
      expect(find.byType(AppFlowyEditor), findsOneWidget);
    });
  });
}

/// Updates the editor selection to the specified [selection].
///
/// If [selection] is null, the current selection will be cleared.
/// If [reason] is provided, it will be used to identify the source
/// of the selection change for debugging purposes.
///
/// Example:
/// ```dart
/// editorState.updateSelection(
///   Selection.single(
///     path: [0],
///     startOffset: 0,
///     endOffset: 5,
///   ),
/// );
/// ```
void updateSelection(Selection? selection, {String? reason}) {
  // Implementation
}

## Description
[Describe your changes in detail]

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Testing
- [ ] Tests pass locally
- [ ] Added new tests
- [ ] Manual testing completed

## Checklist
- [ ] Code follows style guidelines
- [ ] Self-reviewed the code
- [ ] Commented complex sections
- [ ] Updated documentation
- [ ] No new warnings generated
- [ ] Added tests that prove the fix/feature works

## Related Issues
Closes #[issue number]

## Screenshots (if applicable)
[Add screenshots or GIFs]