swagger-api / swagger-api/swagger-codegen

Separate samples from sources and from application

Open
#537 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

General: Suggestion
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Hello!
I want to help write some unit tests and simplify complexity of the code.

But it seems that a lot of stuff here that should be in other place:

  • Samples: seems that they should be in separate repo called swagger-codegen-samples and simply use latest release of CLI-interface to build new versions.
  • Swagger-generator: think it should be in repo called swagger-generator and contains modules:
    • swagger-web-app (with content of current module swagger-generator - is it same as in repo swagger-generator?)
    • swagger-cli (with content of current class Codegen) (done in #547)

Also, think repo swagger-parser should be in this repo, because of parsing schema with classes from swagger-parser repo only used to generate some kind of code. (answered)

Also, is there any doc of how to contribute to project? (answered)

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

Start by reviewing the repository’s module layout and the referenced modules/swagger-codegen/src/main/java/com/wordnik/swagger/codegen/Codegen.java class, then compare the current samples and swagger-generator contents with the proposed repository split. Confirm the intended boundaries with maintainers before changing anything; done would mean an agreed separation plan, since several points are already marked answered or done.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Refactor
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.