swagger-api / swagger-api/swagger-codegen-generators

Wiki on adding a new generator could use some small edits

Open
#1,344 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
299
Forks
439
PR merge metrics
No merged PRs in 30d

Description

I made my way to the wiki page on Adding a new generator from the page on standalone generator development.

I couldn't resist making a few edits. Totally understand if the team don't want them, but you can upstream them from https://github.com/jonnybot0/swagger-codegen-generators/wiki/Adding-a-new-generator-for-a-language-or-framework.#codegen-pojos. Sadly, GitHub doesn't do PRs for wikis, so you'd have to do it the hard way. If you want them, here's a script to make it easy in your current local clone of the wiki:

cd swagger-codegen-generators.wiki
git remote add jonnybot0 https://github.com/jonnybot0/swagger-codegen-generators.wiki.git
git fetch jonnybot0
git merge jonnybot0/master
git push origin master

If not, no hard feelings. They're purely stylistic/grammar changes, so you can take it or leave it. :)

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

Open the “Adding a new generator for a language or framework” wiki page and compare it with the edited version at the reporter’s repository, especially the codegen-pojos section. Use the provided wiki-clone commands if needed; done means the intended stylistic and grammar edits are reviewed and, if accepted, present on the project wiki.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.