Contributing to DocuElevate

Thank you for your interest in contributing to DocuElevate! This document provides guidelines and instructions for contributing to the project.

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct.

How to Contribute

Reporting Bugs

If you find a bug in the codebase, please submit an issue on GitHub with:

A clear title and description
Steps to reproduce the issue
Expected behavior
Actual behavior
Environment information (OS, Docker version, etc.)

Feature Requests

We welcome feature requests! Please submit an issue with:

A clear title and description
The problem the feature would solve
Any ideas you have for implementing the feature

Pull Requests

Fork the repository
Create a new branch for your changes
Make your changes
Run the tests to ensure everything works
Submit a pull request with a clear description of the changes

Development Environment

Setting Up Your Environment

# Clone the repository
git clone https://github.com/christianlouis/document-processor.git
cd document-processor

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt
pip install -r requirements-dev.txt

Running Tests

pytest

Code Style

We use:

Black for Python code formatting
Flake8 for linting
isort for import sorting

# Format code
black .

# Check linting
flake8

# Sort imports
isort .

1.6 KiB Raw Blame History