Contributing to HoloMUSH

HoloMUSH is open-source (Apache-2.0) and welcomes contributions of all kinds — code, documentation, bug reports, and feature suggestions all help build the future of text-based virtual worlds.

Ways to Contribute

Code

Bug fixes — find and fix issues in the codebase
Features — implement new capabilities
Plugins — create example plugins for the community
Tests — improve coverage and reliability

Documentation

Guides — improve contributor and operator docs
Architecture — help keep design docs accurate
Tutorials — write walkthroughs for common tasks

Feedback

Bug reports — help us find and track problems
Feature requests — suggest new capabilities
Community — help other users and developers

Getting Started

Fork the repository on GitHub
Clone your fork locally
Run task setup to install dependencies and configure hooks
Find an issue — look for good-first-issue labels, or browse open issues for unblocked tasks
Create a feature branch, make your changes, and open a pull request

How-to guides Branch naming, PR format, pre-push quality gate, and review process.

Reference Go conventions, testing patterns, error handling, and style guide.

Explanation System design, event model, plugin system, and gateway boundary.

Start here → Pull Request Guide

Development Workflow

HoloMUSH uses a spec-driven, test-first development approach:

The typical cycle looks like this:

Pick a task from open issues
Write failing tests
Implement until tests pass
Run task test && task lint
Open a PR and address review feedback

Code of Conduct

We are committed to providing a welcoming and inclusive environment for everyone. All participants are expected to treat each other with respect, act in good faith, and follow common standards of professional courtesy. Harassment, discrimination, and disruptive behavior are not tolerated.

License

HoloMUSH is licensed under Apache-2.0. By contributing, you agree that your contributions will be licensed under the same terms.