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

Documentation for JSON formats (automata and test cases)

Aperta Adatta ai principianti
  • Qualcosa non va?
#256 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
json, typescript
Ambito
documentation

Direzione di ricerca

Inizia individuando i file JSON dell’automa e dei casi di test, oppure il codice che li carica, per identificare i formati; l’issue include un esempio di caso di test con un array tests e i campi id, string e expectedAccept. Documenta entrambe le strutture e includi file JSON di esempio. Il lavoro è completato quando i lettori possono capire i formati e creare file di casi di test seguendo la documentazione.

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

Descrizione

documentation enhancement

I don't believe we have the structure for our automaton or test case JSON files documented anywhere. This is especially an issue for the test cases, because there is currently no way to export a JSON file from the editor. As a result, the only way to create test cases is to know the JSON format beforehand and write one by hand. For reference I was able to write the following file and have the program use it:

{
    "tests": [
        {
            "id": "test1",
            "string": "aaa",
            "expectedAccept": true
        },
        {
            "id": "test2",
            "string": "b",
            "expectedAccept": true
        }
    ]
}

Having example JSON files as well as documentation explaining their structure would be very helpful for further development.

Lingua principale
TypeScript
Stelle
1
Fork
23
Merge medio
3g 7h
PR unite (30g)
7

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 AutomatonBuilderGUI/AutomatonBuilderGUI

Tutte le issue di AutomatonBuilderGUI/AutomatonBuilderGUI

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.