Skip to content

Commit 415e8a9

Browse files
underaclaude
andcommitted
Add plugin submission guide for the marketplace
New wiki page documenting how to get a plugin listed (PR adding a descriptor to various.json, source/format/value requirements), linked from the nav and Start page. CONTRIBUTING.md points GitHub submitters to it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 11aa2ea commit 415e8a9

4 files changed

Lines changed: 42 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributing
2+
3+
**Listing your plugin in the marketplace** — see
4+
[Submitting Your Plugin to the Marketplace](https://jmeter-plugins.org/wiki/SubmitYourPlugin/).
5+
In short: open a PR adding a descriptor entry to `site/dat/repo/various.json`.
6+
7+
**Contributing plugin code to this project** — see the
8+
[Developers Guidelines](https://jmeter-plugins.org/wiki/DeveloperGuide/).

site/dat/wiki/Start.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
# Developing Plugins
9191
- [Contibutors List](/wiki/Contributors/) - write down yourself, if you took your part
9292
- [DeveloperGuide](/wiki/DeveloperGuide/)
93+
- [Submitting Your Plugin to the Marketplace](/wiki/SubmitYourPlugin/)
9394
- [BuildingFromSource](/wiki/BuildingFromSource/)
9495
- [PluginsGuiGuidelines](/wiki/PluginsGuiGuidelines/)
9596
- [Roadmap](/wiki/Roadmap/) and [Changelog](/wiki/Changelog/)

site/dat/wiki/SubmitYourPlugin.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Submitting Your Plugin to the Marketplace
2+
3+
If you have published a JMeter plugin and want it listed in the
4+
[Plugins Manager](/wiki/PluginsManager/) catalogue, send a pull request to the
5+
[project repository](https://github.com/undera/jmeter-plugins). You add a small descriptor
6+
that points at your released artifact — the plugin code itself stays in your own repository.
7+
8+
## What to change
9+
10+
- **New plugin:** append one entry to `site/dat/repo/various.json` (the array of community
11+
plugins). Do not create a new `.json` file.
12+
- **New version of a plugin already listed:** add a key to that plugin's existing `versions`
13+
map.
14+
15+
For the full list of descriptor fields and a complete example, see
16+
[Plugin Repository Descriptor Format](/wiki/PluginRepositoryDescriptorFormat/).
17+
18+
## Requirements
19+
20+
- **Stable download location.** Each version's `downloadUrl` must point at
21+
[Maven Central](https://central.sonatype.com/) or your project's GitHub releases — a public,
22+
permanent URL.
23+
- **Version key matches the artifact.** The key in the `versions` map must match the version in
24+
the JAR filename, e.g. `1.0.4``…/my-plugin-1.0.4.jar`.
25+
- **Formatting.** Run `python3 format_repo.py` before committing. CI verifies this with
26+
`python3 format_repo.py --check`; the JSON must use 2-space indentation and end with a
27+
newline.
28+
- **Real, reusable value.** The plugin should do something not already covered by a built-in
29+
JMeter feature or a plugin already in the catalogue.
30+
31+
Contributing plugin *code* to this project (rather than listing your own) is covered by the
32+
[Developers Guidelines](/wiki/DeveloperGuide/).

site/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ nav:
108108
- wiki/BuildingFromSource.md
109109
- wiki/PluginsGuiGuidelines.md
110110
- wiki/PluginRepositoryDescriptorFormat.md
111+
- wiki/SubmitYourPlugin.md
111112
- wiki/Contributors.md
112113
- wiki/Roadmap.md
113114
- wiki/Changelog.md

0 commit comments

Comments
 (0)