Ship only the plugin's own files to users, not the repo's development tooling

Open
#33 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
shell
Domain
tooling

Research direction

Start by inspecting the repository layout and how the self-hosted marketplace and plugin directory package the plugin. Identify the checks and tests that validate an installed plugin, then run them against the reduced install contents. Done means a fresh install from both sources contains the listed runtime files, and all checks and tests still pass against that package.

Written by the indexing model from the issue text.

Description

Problem

The plugin's source is the whole repository, so every install copies the development tooling along with the plugin: package.json, the lockfile, test and CI scripts, GitHub workflows, and contributor docs. None of it is used at runtime. It enlarges every install, and it puts files in front of directory reviewers and security scanners that have nothing to do with what the plugin does on a user's machine.

Acceptance criteria

  • A fresh install of the plugin contains only what it uses at runtime: the manifest, skills, MCP config, launch script, icon, README, and license.
  • Every check and test still runs against the plugin as users receive it.
  • Installs from the self-hosted marketplace and the plugin directory both receive the reduced set.

Non-goals

  • Changing what the plugin does at runtime.
  • Changing how releases are cut.

Affected contracts

What a plugin install contains.

Dominant language
Shell
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 dequelabs/axe-accessibility

All issues in dequelabs/axe-accessibility

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.