Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (52 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

82 lines (52 loc) · 1.5 KB

Contributing to Print Spool Optimizer

First off, thank you for considering contributing 🎉
We welcome improvements, fixes, documentation updates, and feature ideas.

📌 Code of Conduct

Be respectful and constructive. We aim to build a professional, inclusive open-source environment.

🛠 Development Setup

-- Check README for Dev Setup

Branch Naming Convention

Use descriptive branch names:

  1. feature/add-batch-processing

  2. fix/cli-validation-bug

  3. docs/readme-update

  4. refactor/logging-structure

Testing

If adding functionality:

  • Add unit tests (if applicable)

  • Ensure no existing functionality breaks

  • Test with large PDF files when possible

Code Style Guidelines

  • Follow PEP8

  • Keep functions modular and readable

  • Add docstrings for new functions

  • Avoid unnecessary dependencies use :

flake8
black

Commit Message Format

Use clear, conventional commit messages:

  • feat: add batch processing support
  • fix: handle corrupted pdf error
  • docs: update installation section
  • refactor: improve logging structure

Pull Request Process

Create a feature branch Commit changes Push to your fork Open a Pull Request Fill in the PR template

What We’re Looking For

Clean architecture improvements Performance optimizations Printer compatibility enhancements Better documentation UI improvements (future scope)

Reporting Security Issues

If you discover a security vulnerability, please email the maintainer directly instead of opening a public issue.