Skip to content

Contributing

OmniWM welcomes bug fixes, documentation improvements, performance work, focused cleanups, features, and thoughtful ideas — along with demos, examples, and tutorials that help others use the project.

On direction: keep contributions in Swift so the codebase stays cohesive, and keep changes focused — smaller, well-explained pull requests are much easier to review and merge. Refactors are fine when they solve a real problem, but they should come with a detailed reason: what is not working well today, why the refactor is needed, and what it improves. For larger changes, open an issue or start a discussion first so we can align on direction.

The canonical, always-current guide — pull request expectations, trace files, and the full workflow — is CONTRIBUTING.md on GitHub. To build and verify your change locally, see Building from Source.

This website lives in the repository’s website/ directory, and knowledge-base pages are plain Markdown under website/src/content/docs/. Every page has an “Edit page” link that opens its source on GitHub, so small fixes are one click away. To add a new page, see the website README.