Skip to content

Contributing

ShieldedShell is open source on GitHub. We welcome bug reports, engine profile fixes, docs improvements, and benchmark ideas.

Development setup

git clone https://github.com/connerkup/shielded-shell.git
cd shielded-shell
npm install
npm test
npm run build

Docs site:

cd website
npm install
npm run dev

Pull requests

Fork and branch from main.
Run npm test and npm run build.
For docs changes, run npm run build in website/.
Open a PR with how you tested (unit tests, doctor, live engine if applicable).

Full guide: CONTRIBUTING.md on GitHub.

History

Public main is a squashed beta tree. Granular commit history is on branch archive/devlog-full-history.

Security

Report vulnerabilities privately. See SECURITY.md.

Links