Skip to main content
Thanks for considering contributing to Exon! We always welcome community PRs. Follow these basic guidelines to get started.

Workflow

1

Clone & Branch

Fork and clone the repository, then create a new branch for your specific feature or fix.
2

Run CLI Locally

Always run and test CLI changes locally before submitting. Use node ./dist/bin/exon.js after building, or run your typical TypeScript dev flow.
3

Create Pull Request

Keep your changes focused. Open a Pull Request from your branch against the main repository and write a clear, descriptive PR title and body.

Adding Template Updates

If adding templates or touching the scaffold generation, ensure:
  • Template folders are complete and tested internally.
  • Include deps.json and env.append if external dependencies/environment variables are required.
  • Any runtime scripts referenced in package.json are cross-platform friendly (Windows, macOS, Linux).