CONTRIBUTING.md

Contributing to Redterm

Thank you for your interest in improving Redterm!

Quick Start

• Fork and clone this repo.
• Use redterm.ps1 on Windows to test.
• All logging, clipboard, and prompt features should be customizable through CLI or in-script settings.
• Keep all documentation up to date (README, man page drafts, usage notes).
• Submit PRs with a clear summary of what was changed or improved.

Code Style

• PowerShell: use UTF-8 encoding for scripts.
• Prefer Write-Host for user prompts, Out-File for logs.
• Keep functions self-contained and document public functions with PowerShell-style comments.
• Name parameters clearly: e.g., -LogSizeMB, -Clipboard, -LogPath.
• Test for edge cases: large logs, permission issues, clipboard errors.

Commits & Branches

• Use descriptive branch names, e.g., feature/env-sync, fix/clipboard-tail.
• Reference issues in commit messages when relevant.
• Keep commits focused; avoid "mega-commits" that touch everything at once.

Issues & Feature Requests

• Use the issue tracker for bugs, ideas, or enhancement suggestions.
• Please specify:
  • OS version & PowerShell version
  • What you expected vs what happened
  • Any relevant log excerpts

Security

• Do not log secrets or credentials.
• Avoid transmitting logs off-machine unless encryption is implemented (future roadmap).

Thank you for helping make Redterm better!