Contributing to Mistcraft

Thank you for your interest in contributing to Mistcraft. This page covers everything you need to get started.

Project overview

Mistcraft consists of several components that work together:

• Misting — Resource management library for state tracking and deployment. The heart of Mistcraft.
• Mistwrite — A declarative Infrastructure-as-Code DSL. Can also be used independently for configuration management.
• Mistup — CLI interface for interacting with Mistcraft systems.
• Mistforge — Code generator for building Mistcraft plugins from schema definitions.
• Plugins — Extensible cloud provider implementations.

Types of contributions

We welcome various types of contributions:

• Bug fixes — Help squash bugs and improve stability.
• Documentation — Improve docs, add examples, or fix typos.
• Tests — Add test coverage for existing or new functionality.
• Plugins — Add support for new cloud providers or services.

Look for issues labeled help wanted or bug. If you want to work on something not listed, please open an issue first to discuss.

License

Mistcraft is dual-licensed under Apache 2.0 and MIT. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion is dual-licensed under the same terms.

Questions? Start a discussion on GitHub Discussions.