Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 1.93 KB

File metadata and controls

68 lines (46 loc) · 1.93 KB

Contributing to FileOrb

Thanks for your interest in contributing to FileOrb v1.0.

Author: Muhammad Ali
Contact: Instagram @x404ctl | GitHub @MAliXCS | Alizarghunrajput@gmail.com


How to Contribute

Reporting Bugs

Open an issue on GitHub with:

  • Python version (python --version)
  • Operating system and version
  • Full traceback / error message
  • Steps to reproduce

Suggesting Features

Open an issue with the label enhancement. Describe:

  • What problem it solves
  • What the expected behaviour should be

Submitting Code

  1. Fork the repository
  2. Create a branch: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Test on Windows and/or Linux
  5. Submit a pull request with a clear description

Adding New File Extensions

The EXT dictionary in fileorb_v1.0.py maps extensions to (category, destination, colour, label) tuples. To add a new type:

".xyz": ("Category", "Category/SubFolder", C_BLUE, "[XYZ]"),

Pick a colour constant from the palette at the top of the file.

Code Style

  • Single file, stdlib only — no external dependencies
  • Follow the existing naming convention (_build_tab_*, _run_*, _refresh_*)
  • All UI text must be emoji-free (use bracket labels like [IMG])
  • New features should push to _undo_stack if they modify self.files

Development Notes

The application is structured as a single App class in one file. Key areas:

Area Lines (approx) Description
Constants + EXT dict 1–310 Colours, extension map, magic bytes, helper functions
_build_* methods 655–1060 All UI construction
_build_tab_intelligence 1066–1440 Intelligence tab + analysis engine
Action methods 1636–1900 Approve, skip, scan, apply, organize
Clipboard + Undo 2124–2215 Copy/cut/paste, undo/redo stack
Real-time watcher 2216–2270 Background polling thread

FileOrb v1.0 — MIT License