codefori/vscode-ibmi

Developer documentation needs improving

Offen

#1.892 geöffnet am 29.02.2024

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (153 Forks)auto 404
documentationgood first issue

Repository-Metriken

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

Beschreibung

Has references to APIs that don't exist anymore or are deprecated

  • code-for-ibmi.runCommand becomes connection.runCommand :+1:

Contributor Guide

Research-Richtung
Finden Sie die Entwicklerdokumentationsdateien im Repository. Suchen Sie nach allen Verweisen auf die veraltete API `code for ibmi.runCommand` und ersetzen Sie sie durch `connection.runCommand`. Überprüfen Sie außerdem, ob es im Dokumentation andere veraltete oder veraltete API Verweise gibt.
Tech Stack
typescript
Domain
developer experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80