Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (21 loc) · 973 Bytes

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 973 Bytes

Contributing to KnowledgeDigest

Thanks for your interest in contributing!

Getting Started

  1. Fork and clone: git clone https://github.com/YOUR_USERNAME/knowledgedigest.git
  2. Install: pip install -r requirements.txt
  3. Run: python -m KnowledgeDigest --gui or --web

How to Contribute

  • Bug fixes: Open an Issue or submit a PR directly
  • New document formats: Extend the extraction pipeline
  • Search improvements: FTS5 queries, ranking, highlighting
  • Web Viewer features: New pages, better UI
  • Documentation: Always appreciated

Good First Issues

Look for good first issue labels.

Guidelines

  • Python 3.10+, PySide6 for GUI
  • Web Viewer: stdlib only (no external web frameworks)
  • One feature/fix per PR
  • Update docs if behavior changes

License

By contributing, you agree that your contributions will be licensed under the MIT License.