Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Documentation: Update README.md

Aperta
#99 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
62/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Inizia da README.md e rivedi la sezione esistente sulla configurazione del frontend. Documenta la configurazione dell’API backend, i contatti, la compilazione del progetto e l’esecuzione dell’applicazione in produzione; il lavoro è completato quando un nuovo membro può seguire il README per la configurazione, la build e l’uso in produzione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

good first issue priority: low type: documentation

Description

Currently README is outdated and unhelpful for new members/ anyone who hasn't interacted with Dashboard.

  • Add concise yet informative intro section.
  • Add "getting started" section.
    • walks through front end setup.
    • walks through backend API set up.
  • Added Contacts section, @favillat for example.
  • Add a "building" section
    • walk through compiling project.
    • running said production app.
Lingua principale
TypeScript
Stelle
2
Fork
2
Merge medio
4g 10h
PR unite (30g)
3

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di SunDevilRocketry/Flight-Software-GUI

Tutte le issue di SunDevilRocketry/Flight-Software-GUI

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.