swagger-api / swagger-api/swagger-ui

Plugin project seed (or similar)?

Open
#4,407 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: documentation cat: plugins type: discussion type: housekeeping
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Is there some kind of seed project with all the boilerplate code to start coding a plugin?
You know, with all these build, package, publish stuff...

Should we start from the swagger-ui source or can be an isolated project?

Cannot find anything in the repo doc nor anything released in the wild.

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.

Research direction

Review the swagger-ui source and repository documentation, noting that the issue reports no existing plugin seed project. Define what a starter project must cover for build, package, and publish workflows, and clarify whether it should be isolated or based on the swagger-ui source. Done means the project structure and starting path are documented and available to plugin authors.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.