|
| 1 | +# Contributing to Redterm |
| 2 | + |
| 3 | +Thank you for your interest in improving Redterm! |
| 4 | + |
| 5 | +## Quick Start |
| 6 | + |
| 7 | +- Fork and clone this repo. |
| 8 | +- Use `redterm.ps1` on Windows to test. |
| 9 | +- All logging, clipboard, and prompt features should be customizable through CLI or in-script settings. |
| 10 | +- Keep all documentation up to date (README, man page drafts, usage notes). |
| 11 | +- Submit PRs with a clear summary of what was changed or improved. |
| 12 | + |
| 13 | +## Code Style |
| 14 | + |
| 15 | +- PowerShell: use `UTF-8` encoding for scripts. |
| 16 | +- Prefer `Write-Host` for user prompts, `Out-File` for logs. |
| 17 | +- Keep functions self-contained and document public functions with PowerShell-style comments. |
| 18 | +- Name parameters clearly: e.g., `-LogSizeMB`, `-Clipboard`, `-LogPath`. |
| 19 | +- Test for edge cases: large logs, permission issues, clipboard errors. |
| 20 | + |
| 21 | +## Commits & Branches |
| 22 | + |
| 23 | +- Use descriptive branch names, e.g., `feature/env-sync`, `fix/clipboard-tail`. |
| 24 | +- Reference issues in commit messages when relevant. |
| 25 | +- Keep commits focused; avoid "mega-commits" that touch everything at once. |
| 26 | + |
| 27 | +## Issues & Feature Requests |
| 28 | + |
| 29 | +- Use the issue tracker for bugs, ideas, or enhancement suggestions. |
| 30 | +- Please specify: |
| 31 | + - OS version & PowerShell version |
| 32 | + - What you expected vs what happened |
| 33 | + - Any relevant log excerpts |
| 34 | + |
| 35 | +## Security |
| 36 | + |
| 37 | +- Do **not** log secrets or credentials. |
| 38 | +- Avoid transmitting logs off-machine unless encryption is implemented (future roadmap). |
| 39 | + |
| 40 | +Thank you for helping make Redterm better! |
0 commit comments