http-party/node-portfinder

Update documentation for `getPort`, `getPorts`, `getSocket`

Open

#170 geöffnet am 12. März 2025

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (101 Forks)github user discovery
good first issue

Repository-Metriken

Stars
 (899 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Update documentation for getPort, getPorts, getSocket

Follow the idea for docs from https://caolan.github.io/async/v3/docs.html#concat

see #168 and #169 for context.

Remove the *Promise based docs and only document getPort, getPorts, getSocket

Great issue for new contributors. Feel free to make a pull request! Don't hesitate to ask if you need help or are confused.

Contributor Guide

Research-Richtung
Überprüfe die vorhandene Dokumentation für die genannten Funktionen und aktualisiere sie gemäß dem Muster, das in der concat Dokumentation der async Bibliothek verwendet wird. Stelle sicher, dass alle *Promise basierten Dokumente entfernt werden.
Tech Stack
javascript
Domain
documentation
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.
Aktiv
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.
85