🤝 Contributing to FLX CLI

FLX CLI-এ contribution করার জন্য ধন্যবাদ! আমরা community contributions কে স্বাগত জানাই এবং project-কে আরও ভাল করতে আপনার সাহায্য চাই।

Getting Started

Prerequisites

Contributing করার আগে নিশ্চিত হন যে আপনার system-এ এগুলো installed আছে:

# Dart SDK (latest stable)
dart --version

# Git
git --version

# IDE (VS Code/IntelliJ/Android Studio)
code --version

Setting Up Development Environment

1. Repository Fork করুন:

# Fork the repository to your GitHub account
# Then clone your fork
git clone https://github.com/YOUR_USERNAME/flx_cli.git
cd flx_cli

2. Dependencies Install করুন:

# Install dependencies
dart pub get

# Run tests to ensure everything works
dart test

3. Development Branch তৈরি করুন:

# Create a new branch for your feature
git checkout -b feature/your-feature-name

Development Guidelines

Code Style

আমরা consistent code style maintain করি। প্রতিটি contribution-এ এই guidelines follow করুন:

// ✅ Good: Clear naming and proper formatting
class FeatureGenerator {
  final String featureName;
  final TemplateType templateType;

  FeatureGenerator({
    required this.featureName,
    required this.templateType,
  });

  Future<void> generateFeature() async {
    await _validateFeatureName();
    await _createDirectoryStructure();
    await _generateFiles();
  }

  Future<void> _validateFeatureName() async {
    if (featureName.isEmpty) {
      throw ValidationException('Feature name cannot be empty');
    }
  }
}

// ❌ Bad: Poor naming and formatting
class fg {
  String n;
  var t;

  fg(this.n, this.t);

  void gen() async {
    if(n=="") throw Exception("bad");
    // more code...
  }
}

Project Structure

lib/
├── core/                   # Core utilities and constants
│   ├── commands/          # Base command classes
│   ├── generators/        # Code generation utilities
│   ├── templates/         # Template management
│   └── utils/             # Helper utilities
├── features/              # Feature-specific implementations
│   ├── auth/             # Authentication feature generator
│   ├── dashboard/        # Dashboard generator
│   └── common/           # Common features
└── cli/                  # CLI interface and argument parsing

Testing Standards

আমরা comprehensive testing maintain করি। প্রতিটি contribution-এ tests থাকতে হবে:

// Unit Test Example
import 'package:test/test.dart';
import 'package:flx_cli/features/auth/auth_generator.dart';

void main() {
  group('AuthGenerator', () {
    late AuthGenerator generator;

    setUp(() {
      generator = AuthGenerator(
        featureName: 'user_auth',
        stateManagement: StateManagement.getx,
      );
    });

    test('should generate auth files correctly', () async {
      // Arrange
      final expectedFiles = [
        'auth_controller.dart',
        'auth_binding.dart',
        'auth_page.dart',
      ];

      // Act
      final result = await generator.generate();

      // Assert
      expect(result.isSuccess, isTrue);
      expect(result.generatedFiles, containsAll(expectedFiles));
    });

    test('should throw exception for invalid feature name', () {
      // Arrange & Act & Assert
      expect(
        () => AuthGenerator(featureName: '', stateManagement: StateManagement.getx),
        throwsA(isA<ValidationException>()),
      );
    });
  });
}

Integration Tests

// Integration Test Example
import 'package:test/test.dart';
import 'package:flx_cli/cli/flx_cli.dart';

void main() {
  group('CLI Integration Tests', () {
    test('should generate complete feature structure', () async {
      // Arrange
      final cli = FlxCli();
      final args = ['gen', 'feature', 'product', '--state-management=getx'];

      // Act
      final result = await cli.run(args);

      // Assert
      expect(result.exitCode, equals(0));
      expect(result.output, contains('Feature generated successfully'));
      
      // Verify files exist
      expect(File('lib/features/product/presentation/pages/product_page.dart').exists(), isTrue);
      expect(File('lib/features/product/domain/entities/product_entity.dart').exists(), isTrue);
    });
  });
}

Types of Contributions

🐛 Bug Fixes

Bug fix করার জন্য:

1. Issue তৈরি করুন bug report সহ
2. Root cause analyze করুন
3. Test case লিখুন bug reproduce করার জন্য
4. Fix implement করুন
5. Test case pass করান

✨ New Features

New feature add করার জন্য:

1. Feature proposal তৈরি করুন GitHub issue-এ
2. Design document লিখুন
3. Community feedback নিন
4. Implementation plan করুন
5. Code এবং tests লিখুন

📝 Documentation

Documentation improve করার জন্য:

1. Current documentation review করুন
2. Missing বা unclear parts identify করুন
3. Clear এবং comprehensive content লিখুন
4. Examples এবং code samples যোগ করুন

🎨 Templates

New template তৈরি করার জন্য:

// Template Example
class CustomPageTemplate extends PageTemplate {
  @override
  String generate(PageConfig config) {
    return '''
import 'package:flutter/material.dart';
import 'package:get/get.dart';

class ${config.className}Page extends StatelessWidget {
  const ${config.className}Page({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('${config.title}'),
      ),
      body: const Center(
        child: Text('${config.className} Page'),
      ),
    );
  }
}
''';
  }
}

Pull Request Process

Before Submitting

1. Code quality check করুন:

# Format code
dart format .

# Analyze code
dart analyze

# Run tests
dart test

# Check test coverage
dart test --coverage

2. Commit messages follow করুন:

# Feature commits
feat: add authentication feature generator

# Bug fix commits
fix: resolve null pointer exception in template parser

# Documentation commits
docs: update installation guide with Windows steps

# Test commits
test: add unit tests for dashboard generator

Pull Request Template

## Description
Brief description of changes made

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Performance improvement

## Testing
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing completed

## Checklist
- [ ] Code follows style guidelines
- [ ] Self-review completed
- [ ] Documentation updated
- [ ] Tests pass locally

Review Process

1. Automated checks: CI/CD pipeline সব tests এবং quality checks run করবে
2. Code review: Maintainers code review করবে
3. Feedback: Review feedback address করুন
4. Approval: Approved হলে merge হবে

Community Guidelines

Code of Conduct

আমরা inclusive এবং welcoming community maintain করি:

• Respectful communication: সবার সাথে respectful ভাবে communicate করুন
• Constructive feedback: Helpful এবং constructive feedback দিন
• Collaborative spirit: Team work এবং knowledge sharing encourage করুন
• Learning mindset: নতুন শেখার জন্য open থাকুন

Communication Channels

• GitHub Issues: Bug reports এবং feature requests
• GitHub Discussions: General discussions এবং questions
• Discord: Real-time chat এবং community support
• Twitter: Updates এবং announcements

Development Resources

Useful Commands

# Generate new command template
dart run lib/tools/generate_command.dart command_name

# Run specific test file
dart test test/specific_test.dart

# Generate coverage report
dart test --coverage && genhtml coverage/lcov.info -o coverage/html

# Build executable
dart compile exe bin/flx.dart -o flx

Local Testing

# Test CLI locally
dart run bin/flx.dart gen feature test_feature

# Test with custom configuration
dart run bin/flx.dart config --state-management=bloc

# Test help system
dart run bin/flx.dart --help

Debugging

// Add debug logging
import 'package:logging/logging.dart';

final _logger = Logger('FeatureGenerator');

void generateFeature() {
  _logger.info('Starting feature generation');
  // Your code here
  _logger.fine('Feature generation completed');
}

Release Process

Version Numbering

আমরা Semantic Versioning ব্যবহার করি:

• Major (1.0.0): Breaking changes
• Minor (1.1.0): New features (backward compatible)
• Patch (1.1.1): Bug fixes

Release Checklist

1. Version bump করুন pubspec.yaml-এ
2. CHANGELOG.md update করুন
3. Tag তৈরি করুন git tag v1.2.3
4. Release notes লিখুন
5. Binary publish করুন

Getting Help

Documentation

• API Documentation: Comprehensive API docs
• Examples: Code examples এবং tutorials
• Best Practices: Development best practices guide

Support

• GitHub Issues: Technical problems এবং bug reports
• Discord Community: Real-time help এবং discussions
• Email: maintainers@flxcli.dev

Mentorship

নতুন contributors-দের জন্য mentorship program available:

• First-time contributor guide
• Assigned mentor complex contributions-এর জন্য
• Regular check-ins progress track করার জন্য

আপনার contribution FLX CLI community-কে আরও strong করে তুলবে। আমরা আপনার participation-এর জন্য উন্মুখ!