CONTRIBUTING.md

Contributing to English-Farsi Translation Interface

Thank you for your interest in contributing to our project! This document provides guidelines and best practices for contributions.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for all contributors.

Getting Started

1. Fork the repository
2. Create a new branch for your feature/fix
3. Write clean, documented code
4. Submit a pull request

Development Guidelines

Code Style

• Follow PEP 8 style guide for Python code
• Use meaningful variable and function names
• Add docstrings to functions and classes
• Keep functions focused and single-purpose
• Include type hints where applicable

Testing

• Write unit tests for new features
• Ensure all tests pass before submitting PR
• Add integration tests for complex features

Documentation

• Update README.md if adding new features
• Document API changes
• Include docstrings for new functions/classes
• Add comments for complex logic

Commit Messages

• Use clear, descriptive commit messages
• Start with a verb (Add, Fix, Update, etc.)
• Keep messages concise but informative

Example:

Add text preprocessing for special characters

Pull Request Process

1. Update documentation
2. Add/update tests
3. Ensure CI passes
4. Request review from maintainers
5. Address review feedback

Feature Requests

• Use issue tracker for feature requests
• Clearly describe the feature and its benefits
• Include use cases where applicable

Bug Reports

Include:

• Clear description of the issue
• Steps to reproduce
• Expected vs actual behavior
• System information
• Screenshots if applicable

Questions?

Feel free to open an issue for any questions about contributing!