Azure / Azure/azure-openapi-validator
Document adding linter rule process
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 53
- Forks
- 57
- Ø Merge
- 1 T. 23 Std.
- Gemergte PRs (30 T.)
- 2
Beschreibung
new linter rules when added should be optional ( e.g. as warnings or any other way ) and if the plan is to make them errors, to have a notice that they will become errors in 3 months ( or whatever the period is ).
Also we need to make sure the notice is visible .
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Repository-Dokumentation zu finden, in der erklärt wird, wie linter rules hinzugefügt werden, und überprüfe den aktuellen Prozess. Dokumentiere, wann neue Regeln optional bleiben sollten, wie ein zukünftiger Übergang zu Fehlern angekündigt wird und wo der Hinweis sichtbar sein muss. Erledigt ist die Aufgabe, wenn ein Neuling dem dokumentierten Prozess folgen und den Warnzeitraum verstehen kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation, tooling
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- Ein halber Tag
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100