Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (53 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

81 lines (53 loc) · 1.82 KB

Contributing to SessionVault

Thanks for considering contributing!

Ways to Contribute

  • Report bugs / suggest features (open an issue)
  • Fix bugs / implement features (submit a PR)
  • Improve docs / README
  • Add tests
  • Create plugins (see plugin API in README)
  • Translate / add themes

Development Setup

  1. Clone repo
    git clone https://github.com/Pequito/sessionvault.git

  2. Install deps
    pip install -r requirements.txt

  3. Run
    python sessionvault.py

(For Linux: install `python# Contributing to SessionVault

Thanks for considering contributing!

Ways to Contribute

  • Report bugs / suggest features (open an issue)
  • Fix bugs / implement features (submit a PR)
  • Improve docs / README
  • Add tests
  • Create plugins (see plugin API in README)
  • Translate / add themes

Development Setup

  1. Clone repo
    git clone https://github.com/Pequito/sessionvault.git

  2. Install deps
    pip install -r requirements.txt

  3. Run
    python sessionvault.py

(For Linux: install python-xlib, xfreerdp, vncviewer as needed)

Pull Requests

  • Target main branch
  • Use descriptive titles
  • Include tests if adding features/fixes
  • Follow PEP 8 style
  • Update CHANGELOG.md if user-visible change

Issues

Use clear titles, steps to reproduce, expected vs actual behavior, screenshots if GUI-related.

Small PRs welcome. Questions? Open an issue first.

MIT licensed — all contributions welcome.-xlib, xfreerdp, vncviewer` as needed)

Pull Requests

  • Target main branch
  • Use descriptive titles
  • Include tests if adding features/fixes
  • Follow PEP 8 style
  • Update CHANGELOG.md if user-visible change

Issues

Use clear titles, steps to reproduce, expected vs actual behavior, screenshots if GUI-related.

Small PRs welcome. Questions? Open an issue first.

MIT licensed — all contributions welcome.