GitHub Repository

Organize Portly for clarity and contributor speed. Keep CLI and documentation in one maintainable repository.

Recommended Repository Layout

portly/
├── bin/
│   └── portly.js
├── src/
│   ├── cli.js
│   ├── portScanner.js
│   ├── tunnel.js
│   ├── qr.js
│   └── ui.js
├── utils/
│   └── nameGenerator.js
├── docs-site/
│   ├── index.html
│   ├── docs.html
│   ├── install.html
│   ├── examples.html
│   ├── github.html
│   └── assets/
├── README.md
├── LICENSE
└── package.json

Contribution Workflow

1. Fork + Branch

Create focused branches for each feature or fix.

2. Implement + Test

Run local smoke tests for CLI output and docs pages.

3. Pull Request

Include issue references, before/after behavior, and screenshots for docs changes.

4. Release

Tag versions and publish package updates to npm with matching changelog notes.

Branding Policy

The official Portly logo is used consistently across README, docs header, favicon, and release assets to maintain clear visual identity.