Contributing to Semantica¶

Thank you for your interest in contributing to Semantica!

📚 Essential Links¶

• Contributing Guide - Complete contribution guidelines
• Code of Conduct - Community standards
• Security Policy - Report vulnerabilities
• GitHub Issues - Bug reports and features

🎯 Ways to Contribute¶

Code Contributions¶

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

See the Contributing Guide for detailed instructions.

Documentation¶

• Fix typos and improve clarity
• Add examples and tutorials
• Update API documentation
• Translate documentation

Bug Reports¶

Report bugs on GitHub Issues with: - Description of the problem - Steps to reproduce - Expected vs actual behavior - Environment details

Feature Requests¶

Suggest features on GitHub Issues with: - Use case description - Proposed solution - Benefits to the community

✍️ Documentation Style Guide¶

Writing Guidelines¶

• Use clear, concise language
• Include working code examples
• Test all examples before submitting
• Follow existing documentation structure
• Use proper markdown formatting

API Documentation Format¶

def function_name(
    param1: str,
    param2: int = 0
) -> ReturnType:
    """Brief description.

    Args:
        param1: Description of param1
        param2: Description of param2 (default: 0)

    Returns:
        Description of return value

    Raises:
        ValueError: When and why this is raised

    Example:
        >>> result = function_name("test", 5)
        >>> print(result)
        expected_output
    """

📁 Documentation Structure¶

docs/
├── index.md              # Homepage
├── getting-started.md    # Getting started
├── concepts.md          # Core concepts
├── modules.md           # Module overview
├── use-cases.md         # Use cases
├── examples.md          # Examples
├── cookbook/            # Tutorials
└── reference/           # API reference

🛠️ Documentation Tools¶

• MkDocs - Documentation generator
• Material for MkDocs - Theme
• mkdocstrings - API docs from docstrings
• Mermaid - Diagrams

🤝 Getting Help¶

• GitHub Issues - Ask questions
• Documentation - Check existing docs for examples
• Pull Requests - Review other contributors' PRs