Contributing Guide¶

Join the HoloMUSH community and help build the future of text-based virtual worlds.

Overview¶

HoloMUSH is an open-source project licensed under Apache-2.0. We welcome contributions of all kinds, from code to documentation to bug reports.

Ways to Contribute¶

Code Contributions¶

• Bug Fixes - Find and fix issues in the codebase
• Features - Implement new capabilities
• Plugins - Create example plugins for the community
• Tests - Improve test coverage

Non-Code Contributions¶

• Documentation - Improve guides and API docs
• Bug Reports - Help us find and track issues
• Feature Requests - Suggest new capabilities
• Community - Help other users and developers

Getting Started¶

1. Fork the Repository - Create your own copy on GitHub
2. Set Up Development - Follow the development environment guide
3. Find an Issue - Look for good-first-issue labels
4. Submit a PR - Follow our pull request process

Documentation Sections¶

Development Setup¶

• Development Environment - Set up your local environment
• Building from Source - Compile HoloMUSH
• Running Tests - Execute the test suite

Contribution Process¶

• Pull Request Guide - How to submit changes
• Code Review - What to expect in reviews
• Coding Standards - Style and conventions

Project Information¶

• Roadmap - Planned features and milestones
• Architecture Decisions - ADRs explaining key choices
• Changelog - Release history

Development Workflow¶

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

flowchart TB
    A["Spec (docs/specs/)"] --> B["Epic (tracked in beads)"]
    B --> C["Implementation Plan (docs/plans/)"]
    C --> D["Tasks with Tests"]

See Development Principles for details.

Code of Conduct¶

We are committed to providing a welcoming and inclusive environment. All participants must follow our Code of Conduct.

License¶

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