leonardopolicarpo/iot-firmware-update

Create project documentation (READMEs in EN and PT-BR)

Offen

#6 geöffnet am 02.09.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)TypeScript (0 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (0 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

A good project needs good documentation. Create the main README.md in English and a README.pt-br.md in Portuguese.

Tasks:

[ ] Write the main README.md in English, including:

  • Project objective
  • Architecture overview
  • Tech stack
  • How to run locally (docker compose up)
  • API endpoint usage

[ ] Write the README.pt-br.md with the same content, translated to Portuguese

Contributor Guide

Research-Richtung
Überprüfen Sie die Projektstruktur und den vorhandenen Code, erstellen Sie dann README.md auf Englisch und README.pt br.md auf Portugiesisch gemäß den aufgelisteten Aufgaben.
Tech Stack
typescriptdockeraws
Domain
backend
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.
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
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90