Contributing to Bloxide

Guide developers contributing to the Bloxide framework with no_std and proc macro requirements.

1|2|Updated Jan 10, 2025
One-click install
npx skills add https://github.com/bloxide-com/bloxide --skill contributing-to-bloxide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Contributing to Bloxide
Source: https://github.com/bloxide-com/bloxide/tree/main/skills/contributing-to-bloxide
Command: npx skills add https://github.com/bloxide-com/bloxide --skill contributing-to-bloxide

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide for developers looking to contribute to the Bloxide framework itself, covering its architecture, development processes, and contribution guidelines.

Core Features & Use Cases

  • Framework Understanding: Detailed breakdown of Bloxide's crate structure, dependency rules, and architectural patterns (e.g., two-tier trait system).
  • Contribution Workflow: Guidance on adding new standard library crates, implementing new runtimes, and modifying the core HSM engine.
  • Use Case: A new developer wants to add a new feature to Bloxide's logging capabilities. They would consult this Skill to understand where to add the new crate, how to manage dependencies, and how to ensure no_std compatibility.

Quick Start

Consult the crate map to understand the Bloxide project structure.

Frequently Asked Questions about Contributing to Bloxide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I contribute to the Bloxide framework and add new capabilities?

To contribute to the Bloxide framework, you must follow its architectural patterns, manage crate dependencies, and ensure `no_std` compatibility when adding new capabilities or modifying the HSM engine.

What is the architectural structure of the Bloxide framework for contributors?

The Bloxide framework architecture relies on a two-tier trait system, specific crate dependency rules, and proc macro usage for host compilation to maintain a strict `no_std` embedded environment.

Can I implement a new runtime for the Bloxide actor framework without `no_std`?

No, implementing new runtimes for the Bloxide actor framework requires strict adherence to `no_std` requirements and proper proc macro usage to ensure embedded compatibility.

How do I add a new standard library crate to the Bloxide project?

Adding a new standard library crate to Bloxide requires consulting the crate map to understand project structure, managing dependencies correctly, and adhering to development standards.

What should I know before modifying the core HSM engine in Bloxide?

Before modifying the HSM engine in Bloxide, you need to understand its crate dependency rules, two-tier trait system, and how to maintain `no_std` compliance during development.

Does the Bloxide framework use proc macros for host compilation?

Yes, the Bloxide framework uses proc macros for host compilation, requiring contributors to understand this mechanism alongside crate dependencies and the two-tier trait system.