marmite-development

Guide contributions to the marmite Rust static site generator codebase.

866|54|Updated Oct 14, 2024
One-click install
npx skills add https://github.com/rochacbruno/marmite --skill marmite-development
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: marmite-development
Source: https://github.com/rochacbruno/marmite/tree/main/.agents/skills/marmite-development
Command: npx skills add https://github.com/rochacbruno/marmite --skill marmite-development

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the guesswork and inconsistency of contributing to the marmite Rust static site generator codebase by providing clear, standardized guidelines for code quality, testing, documentation, and contribution workflows, reducing onboarding friction for new contributors and ensuring consistency across all changes.

Core Features & Use Cases

  • Standardized Development Workflows: Pre-defined commands for formatting, linting, testing, and serving the project, plus explicit rules for safe Rust practices, error handling, and naming conventions.
  • Comprehensive Contribution Checklists: Step-by-step requirements for all change types (code updates, new features, bug fixes, PRs), including mandatory test coverage, documentation updates, and template synchronization.
  • Use Case: A developer adding a new stream taxonomy feature to marmite can follow this Skill to ensure their code passes all lint checks, includes unit and integration tests, updates all relevant reference documentation, and aligns with the project's backward compatibility requirements without missing required steps.

Quick Start

Use the marmite-development skill to guide your contribution of a new feature or bug fix to the marmite codebase, following all outlined code quality, testing, and documentation requirements.

Frequently Asked Questions about marmite-development

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

FAQPage Schema
How do I contribute to a Rust static site generator codebase?

To contribute to a Rust static site generator codebase, follow standardized guidelines for safe Rust practices, mandatory test coverage, documentation updates, and pull request workflows to maintain project consistency. This Skill provides the exact checklists required.

What are the testing requirements for open source Rust code contributions?

Open source Rust code contributions require mandatory test coverage, including unit and integration tests for all code updates, new feature implementations, and bug fixes. This Skill enforces these testing requirements to maintain project consistency.

How do I ensure my Rust code changes pass clippy and formatting checks?

To ensure Rust code changes pass clippy and formatting checks, apply pre-defined commands for linting and formatting, explicit rules for error handling, and naming conventions. This Skill outlines the exact commands and safe Rust practices required.

Do I need to update documentation when adding new features to a Rust project?

Yes, you must update documentation when adding new features to a Rust project. This Skill enforces complete documentation requirements, synchronizes template updates, and ensures backward compatibility for all code changes and feature implementations.

What is the best way to submit a pull request for a marmite bug fix?

The best way to submit a pull request for a marmite bug fix is to follow step-by-step contribution checklists, ensuring your code includes mandatory tests, passes all lint checks, and updates relevant reference documentation. This Skill provides the required workflow.

When should I not use automated workflows for open source code contributions?

You should not use automated workflows for open source code contributions when your changes bypass architecture compliance, lack mandatory test coverage, or break backward compatibility. This Skill enforces strict guidelines to prevent missing required steps.