docs: Instructions for partners & contributors of external plugins

Open
#51 0 comments 0 reactions 1 assignee View on GitHub

@suuus is already working on this.

Since May 5, 2026.

Assessment

This issue has not been assessed yet.

Description

documentation

Context

Following the addition of external plugin support in #50, we need documentation for partners and contributors who want to create external plugins for git-ape.

Requirements

  • Document the plugin metadata format and required fields
  • Explain how to register a plugin in the /plugins configuration
  • Provide a step-by-step guide for submitting a new external plugin
  • Include examples based on the ape-context plugin as a reference

Related

  • PR #50 - feat(plugin): add ape-context plugin for enhanced context management
Dominant language
JavaScript
Stars
269
Forks
45
Avg merge
1d 4h
Merged PRs (30d)
15

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/git-ape

All issues in Azure/git-ape

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.