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

score/ts_client: Create detailed design (comp_dd_sta)

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

I maintainer di solito rispondono entro 4 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
cpp
Ambito
documentation

Direzione di ricerca

Inizia dopo il merge di PR #54, quindi esamina le unità GptpIpcPublisher, GptpIpcReceiver e GptpIpcChannel e il formato dei dati di memoria condivisa. Crea score/ts_client/docs/detailed_design/index.rst con una direttiva comp_dd_sta valida, documenta interfacce e responsabilità, collega ogni unità ai requisiti e all’architettura e aggiungi i commenti req-Id richiesti nel codice sorgente.

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

Descrizione

[!IMPORTANT]
Link the implementing PR to this issue by including Closes #89 in the PR description or commit message.

What

Write the detailed design document for score/ts_client.

Create score/ts_client/docs/detailed_design/index.rst using the sphinx-needs comp_dd_sta directive. Decompose the component into units, document their responsibilities and interfaces, and connect every unit to requirements (:implements:) and architecture (:satisfies:).

Note: Create this ticket after PR #54 merges, as it changes the shared memory layer architecture.

Units to cover: GptpIpcPublisher (writes gPTP data into shared memory), GptpIpcReceiver (reads data from shared memory), GptpIpcChannel (shared memory management layer); data format in shared memory.

Acceptance Criteria
  • comp_dd_sta directive in place with :status: valid
  • Shared memory protocol (data format, publisher/receiver contract) described
  • :implements: and :satisfies: links present for every unit
  • req-Id traceability comments in source for every traced unit
References
Lingua principale
C++
Stelle
2
Fork
12
Merge medio
6g 23h
PR unite (30g)
17

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

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 eclipse-score/time

Tutte le issue di eclipse-score/time

Issue simili

Altre issue su C++

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.