Thank you for your interest in contributing! RetroTUI is a community-driven project that aims to bring the Windows 3.1 nostalgia to your terminal.

1. Fork the repository on GitHub.
2. Clone your fork locally:

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

3. Install dependencies (none required for runtime!):
   • For development/testing, you just need Python 3.9+.
   • (Optional) Install gpm if you are on Linux TTY and want mouse support.

Always work on a feature branch, not main.

git checkout -b feature/my-cool-feature

• Python: We target Python 3.9+. Use type hints where possible.
• Text Files: Ensure all files are UTF-8 with LF line endings.
  • We provide .editorconfig to help with this.
• No External Deps: Do not add pip dependencies. RetroTUI must run with standard library only.

Before submitting a PR, run the local QA tool. It checks encoding, syntax, and runs tests.

python tools/qa.py

If you want to check test coverage:

python tools/qa.py --module-coverage

Use clear, descriptive commit messages.

• feat: added X
• fix: resolved issue Y
• docs: updated README

1. Push your branch to your fork.
2. Open a Pull Request against roccolate/RetroTUI:main.
3. Ensure the CI (GitHub Actions) passes.
4. Wait for review!

See ARCHITECTURE.md to understand the system design before making major changes.