Contributing

WormholeSystems is built in the open, and contributions of every size are welcome. It is early enough that almost anything is still up for discussion.

The repository

WormholeSystems/wormholesystems-next — the map, the API and the operator CLI, in one place. Rust on the back, SvelteKit on the front.

Start with the repo's README, then:

  • Found a bug or have an idea? Open an issue. It is the best place to work out whether a change is right before anyone builds it.
  • Want to fix or build something? Fork it, make the change, open a pull request.

Because this is pre-alpha, expect the ground to move under a branch that sits open for long. Small changes land more easily than large ones.

Improving these docs

The documentation you are reading is the easiest place to start. Every page is a plain Markdown file under frontend/src/docs/, one folder per category, and adding a page needs nothing but a file with a title in it — the sidebar, the ordering and the previous/next links all follow on their own.

Writing for somebody flying, rather than somebody reading the source, is the only rule worth stating.

Why bother

  • It helps everyone. A fix or a page you add is one every group using it gets.
  • It is yours too. The same openness that lets you self-host lets you shape where it goes.