score/ts_client: Create detailed design (comp_dd_sta)
Maintainers usually reply within 4 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- cpp
- Domain
- documentation
Research direction
Start after PR #54 merges, then inspect the GptpIpcPublisher, GptpIpcReceiver, and GptpIpcChannel units and the shared-memory data format. Create score/ts_client/docs/detailed_design/index.rst with a valid comp_dd_sta directive, documenting interfaces and responsibilities, linking each unit to requirements and architecture, and adding the required req-Id source comments.
Written by the indexing model from the issue text.
Description
[!IMPORTANT]
Link the implementing PR to this issue by includingCloses #89in 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_stadirective in place with:status: valid - Shared memory protocol (data format, publisher/receiver contract) described
-
:implements:and:satisfies:links present for every unit -
req-Idtraceability comments in source for every traced unit
References
- Dominant language
- C++
- Stars
- 2
- Forks
- 12
- Avg merge
- 6d 23h
- Merged PRs (30d)
- 17
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from eclipse-score/time
-
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
eclipse-score/time#47 ·
Maintainers usually reply within 4 days
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
eclipse-score/time#230 ·
Maintainers usually reply within 4 days
-
Improvement: Add TSan to sanitizer CI and fix the data race it findsPossibly taken @MaciejSalwa543 claimed this 21 days ago. Open
eclipse-score/time#228 · 1 assignee ·
Maintainers usually reply within 4 days
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 65/100
eclipse-score/time#226 ·
Maintainers usually reply within 4 days
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
eclipse-score/time#213 ·
Maintainers usually reply within 4 days
All issues in eclipse-score/time
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
AcademySoftwareFoundation/Imath#611 ·
Maintainers usually reply within 1 day
-
The Outdated Version prompt shows the release tag as unescaped HTMLPossibly taken @on8st claimed this today. Openbug good first issue GUI maintainer-review priority: low
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
aethersdr/AetherSDR#6405 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
bitcoin-core/gui-qml#1003 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
metasequoiaime/msime#7328 ·
Maintainers usually reply within 1 day