Contributing

Contributor docs are separated from the end-user guides on purpose. Start here if you want to build Restish itself, work on the docs site, or understand the core architecture before changing behavior.

Path

Documentation -> Contributing

Start Here

• Development Setup for the local toolchain and common commands.
• Design Records for the subsystem-level architecture documents in the repository’s docs/design/ directory.
• Release Packaging for release artifacts, Homebrew, GitHub releases, Go install, plugin binaries, and changelog checks.
• Docs Maintenance for doc checklists, validation, and migration status.

Good Next Steps

• Read the CLI architecture record before changing shared command behavior.
• Check subsystem design docs before editing auth, spec loading, output, or plugin runtime code.
• Keep public docs focused on user workflows, then link deeper design notes when architecture context matters.