Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (26 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 1.1 KB
Raw

Contributing Plugins

Thanks for contributing to the xfetch plugin ecosystem. This repository contains official plugins and the reference documentation for building new ones.

Workflow

  1. Fork the repository and create a feature branch.
  2. Create or update a plugin directory at the repository root.
  3. Run cargo test --workspace.
  4. Document the plugin in its own README.md and in README.md.
  5. Open a pull request with usage details and any required external dependencies.

Plugin Rules

  • Use the binary naming convention xfetch-plugin-<name>.
  • Keep plugins focused on a single responsibility.
  • Write errors to stderr and exit with a non-zero status on failure.
  • Prefer stable, actively maintained dependencies and keep them minimal.

Protocol Guide

The full protocol, discovery order, and testing workflow are documented in docs/README.md.