Index

Contributing to LDA¶

Thank you for your interest in contributing to Linked Document Analysis (LDA)! This guide will help you get started.

Ways to Contribute¶

1. Report Issues¶

• Bug reports
• Feature requests
• Documentation improvements
• Performance issues

2. Submit Code¶

• Bug fixes
• New features
• Performance improvements
• Test coverage

3. Improve Documentation¶

• Fix typos and errors
• Add examples
• Clarify explanations
• Translate documentation

4. Help Others¶

• Answer questions in discussions
• Review pull requests
• Share your use cases
• Write tutorials

Quick Start¶

1. Fork the repository

   git clone https://github.com/YOUR_USERNAME/LDA.git
   cd LDA
   

2. Set up development environment

   python -m venv venv
   source venv/bin/activate
   pip install -e .[dev,docs]
   

3. Create a branch

   git checkout -b feature/your-feature
   

4. Make changes and test

   pytest
   lda docs serve  # If docs changed
   

5. Submit pull request

   git push origin feature/your-feature
   

Guidelines¶

Code of Conduct¶

• Be respectful and inclusive
• Welcome newcomers
• Focus on constructive feedback
• Assume good intentions

Commit Messages¶

Follow conventional commits:

feat: Add new export format
fix: Handle empty file paths
docs: Update installation guide
test: Add config validation tests

Pull Requests¶

• Keep changes focused
• Include tests
• Update documentation
• Add to changelog
• Reference related issues

Code Style¶

• Follow PEP 8
• Use type hints
• Write clear docstrings
• Keep functions small
• Use meaningful names

Development Guides¶

Need Help?¶

• Read the development guide
• Check existing issues
• Ask in discussions
• Contact maintainers

Recognition¶

Contributors are recognized in: - CONTRIBUTORS.md file - Release notes - Documentation credits - GitHub contributors page

Thank you for making LDA better! 🎉