Contributing

If there is something I missed, a mistake, or a feature you would like added please create an issue or a pull request and I’ll try to get to it.

Warning: all contributions must be done on the beta branch. By default Gitpod will open on the beta branch, but still keep this in mind.

The native initiative uses Changesets, for versioning and Changelog generation, you don’t need to create one, but it would be amazing if you could.

Using Gitpod

You can try out @okikio/emitter using Gitpod:

By default Gitpod will start the dev script for you, but if you need to restart the dev script you can do so by typing into the terminal.

pnpm --filter "@okikio/emitter" exec -- npm test --watch

Once Gitpod has booted up, go to packages/manager/tests/test.ts and start tweaking and testing to your hearts content.

Runing Locally

You can run @okikio/emitter locally by first installing some packages via these commands into your terminal,

npm install -g pnpm
pnpm install -g ultra-runner
pnpm install

You can build your changes/contributions using,

pnpm build

You can test your changes/contributions using,

# For a single test
pnpm test --filter "@okikio/emitter"
# For continouous testing
pnpm --filter "@okikio/emitter" exec -- npm test --watch

Once it has booted up, go to packages/emitter/tests/test.ts and start tweaking and testing to your hearts content.