swagger-api/swagger-codegen

[All] Use .swagger-codegen-ignore instead of writeOptional

Offen

#3.100 geöffnet am 09.06.2016

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Enhancement: Generalhelp wanted

Repository-Metriken

Stars
 (12.701 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

I think .swagger-codegen-ignore is better since it can be configured by the end user whereas writeOptional files are hard-coded in the codegen. For instance, when generating the petstore samples, you want to overwrite the pom.xml but it doesn't occur unless you rm the file first. It would be better to pre-configure in the templates the .swagger-codegen-ignore to ignore pom.xml, build.gradle, etc... The only writeOptional file would then be .swagger-codegen-ignore

Contributor Guide

Research-Richtung
Untersuche die vorhandene Unterstützung für .swagger codegen ignore und vergleiche sie mit der writeOptional Logik. Identifiziere, wo writeOptional verwendet wird, und schlage Änderungen vor, stattdessen die Ignore Datei zu verwenden.
Tech Stack
java
Domain
build system
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJava
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70