We're really glad you're here and would love for you to contribute to Modus! There are a variety of ways to make Modus better, including bug fixes, features, docs, and blog posts (among others). Every bit helps 🙏
Please help us keep the community safe while working on the project by upholding our Code of Conduct at all times.
Before jumping to a pull request, ensure you've looked at PRs and issues (open and closed) for existing work related to your idea.
If in doubt or contemplating a larger change, join the Hypermode Discord and start a discussion in the #modus channel.
The primary development language of Modus is Go. The runtime and supporting packages are all written in Go.
Modus SDKs enable users to build apps in multiple languages, currently including Go and AssemblyScript.
The Modus CLI drives the local development experience and is written in TypeScript.
The fastest path to setting up a development environment for Modus is through VS Code. The repo includes a set of configs to set VS Code up automatically.
To contribute code, start by forking the Modus repository. In the top-right of the repo, click Fork. Follow the instructions to create a fork of the repo in your GitHub workspace.
Wherever possible, we use the built-in capabilities of each language. For example, unit tests for Go components can be run with:
go test ./...When you're ready, open a pull request against the main branch in the Modus repo. Include a clear, detailed description of the changes you've made. Be sure to add and update tests and docs as needed.
We do our best to respond to PRs within a few days. If you've not heard back, feel free to ping on Discord.
Pull requests are awesome, but there are many ways to help.
Modus docs are maintained in a separate repository. Relevant updates and issues should be opened in that repo.
Share what you're building with Modus in your preferred medium. We'd love to help amplify your work and/or provide feedback, so get in touch if you'd like some help!
There are lots of people building with Modus who are excited to connect!