leonardopolicarpo/iot-firmware-update

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

Ouverte

#6 ouverte le 2 sept. 2025

Voir sur GitHub
 (0 commentaire) (0 réaction) (1 personne assignée)TypeScript (0 fork)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (0 étoile)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez la structure du projet et le code existant, puis créez README.md en anglais et README.pt br.md en portugais en suivant les tâches listées.
Stack technique
typescriptdockeraws
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90