TheDevPath/Navi

document API resources

Offen

#123 geöffnet am 17.02.2018

Auf GitHub ansehenContributor Guide
 (15 Kommentare) (0 Reaktionen) (2 zugewiesene Personen)JavaScript (63 Forks)auto 404
backendgood first issuehelp wantedwiki/documentation

Repository-Metriken

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

Beschreibung

Create an API document identifying all the currently available endpoints and the elements within each endpoint. List of tasks to include in issue description

  • Include apidocs tool dependencies in Navi (admin)
  • Develop guidelines that contributors should use while documenting their coded APIs
  • Update each of the code blocks in controllers directory to comply with guidelines mentioned above. On a closer review that is the one directory that is relevant for this task as the files in routes directory uses the APIs defined in the controllers directory. However if there are any additional files that are providing APIs they need to be included here.
    • google-api-controllers.js
    • saved-directions-controllers.js
    • saved-pins-controller.js
    • search-history-controllers.js
    • users-contoller.js
    • utils-controller.js
  • Update contributing guidelines doc to ensure all programmers follow the guidelines before introducing new API code

Contributor Guide

Research-Richtung
Durchsuche das controllers Verzeichnis, um alle API Endpunkte und deren Antworten zu identifizieren. Überprüfe die vorhandenen Richtlinien in CONTRIBUTING.md und stelle sicher, dass jede Controller Datei diese befolgt. Aktualisiere die API Dokumentation entsprechend.
Tech Stack
javascriptnodejs
Domain
backendapi
Issue Type
Dokumentation
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.
Halber Tag
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
GitJavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70