Skip to content

contributing.md

Latest commit

 

History

History
142 lines (87 loc) · 3.79 KB

contributing.md

File metadata and controls

142 lines (87 loc) · 3.79 KB

Kito Plugins – Contribution Guide

Welcome to the Kito plugin contribution guide! Here you'll learn how to contribute to this repository correctly.

This is a monorepo, where each plugin resides in packages/*. A standardized structure is used to maintain consistency across all plugins.

You don’t need to contribute here to support the Kito ecosystem—you can create plugins independently. The difference is that the plugins in this repo are “official” and essential, under the @kitojs scope. Feel free to create your own plugins if you want!

📚 Guide

Requirements

Ensure you have the following tools installed. We maintain a single toolchain, so alternatives will not be accepted.

Getting Started

  1. Fork the repository and clone it locally:
git clone https://github.com/<user>/plugins # or ssh
cd plugins
  1. Install dependencies and approve builds if prompted:
pnpm install
pnpm approve-builds

Optional: Install the Biome extension for your editor to speed up formatting and linting.

Workflow

Branches

Branches follow the type/name format. The type can be:

  • feat: New feature (e.g., a plugin)
  • fix: Bug fix
  • chore: Repository/configuration changes
  • docs: Documentation updates
  • style: Code formatting or lint fixes

The name should describe what the branch does.

Pull Requests

When your work is ready, open a pull request to merge into the dev branch. All development happens there before merging into main.

Pull requests directly to main will be rejected.

Conventional Commits

All commits must follow Conventional Commits:

<type>(<scope>): <subject>
  • Scope: Use the plugin name (e.g., plugin-a) or omit it if the change is general to the repo.
  • Examples:
feat(plugin-a): add new option for config
fix(plugin-b): correct typo in method
chore: update CI workflow

This ensures automatic versioning and changelog generation via Changesets.

Changesets

Changesets are used to manage versions of each plugin independently.

Creating a changeset:

pnpm changeset
  • Select the packages affected and the type of version (major, minor, patch).
  • This generates a .md file inside the .changeset/ folder.
  • Only create a changeset when the change is ready to be released (not for every commit).

Creating a Plugin

Plugins must follow a basic structure. From the repo root, run:

pnpm new:plugin

Follow the interactive menu. Once generated, enter the plugin folder and run:

cd packages/plugin-name

pnpm install
pnpm approve-builds # if prompted

pnpm build

You may modify the folder structure, but keep the minimum base generated.

Don’t forget to add a readme.md consistent with other plugins. Review existing plugins for reference.

🔔 Reminders

  • Sync regularly: Fetch the latest dev branch before starting work to avoid conflicts.
  • Respect formatting: Run pnpm fmt:fix and pnpm lint:fix regularly and before committing.
  • Use Conventional Commits: Always use the plugin name as scope or omit it for repo-wide changes.
  • Generate Changesets only when ready for release.

Alternatively, use the Biome extension for automatic formatting on save.

❤️ Thanks

Thank you for contributing to the Kito ecosystem! Your support is highly appreciated.