Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 1.21 KB

File metadata and controls

21 lines (14 loc) · 1.21 KB

Contributing

Thanks for your interest in websh.

Submitting PRs

  • Use a feature branch, not your fork's main. Open PRs from feat/..., fix/..., docs/..., etc. PRs whose head branch is main will be asked to re-submit — when your main diverges from upstream the workflow gets confusing for both sides.
  • One logical change per PR. Bug fixes, refactors, docs, and unrelated cleanups should be separate PRs. Bundling a refactor under the cover of a hot-fix makes review hard and revert all-or-nothing.
  • Keep descriptions concise. A single-paragraph summary, a brief test plan, and links if needed. Multi-page narratives of internal review processes belong in commit messages of the relevant commits, not in the PR body.
  • Resolve review comments before merging. Branch protection requires it.

Code

  • No build step. The frontend (websh.js, index.html) is plain JS/HTML; the backend (server.py) is stdlib-only Python.
  • Run tests before opening a PR:
    • Backend: python3 test_server.py
    • Frontend: node --check websh.js and node tests/frontend/test_*.js

Reporting bugs

Open an issue with steps to reproduce, browser/OS, and any relevant network constraints (corporate proxy, VPN, etc.).