Skip to content

docs(decisions): add DR-001 for unit test design#105

Open
clanghans wants to merge 1 commit intoeclipse-score:mainfrom
etas-contrib:feature/dr-unit-test-design
Open

docs(decisions): add DR-001 for unit test design#105
clanghans wants to merge 1 commit intoeclipse-score:mainfrom
etas-contrib:feature/dr-unit-test-design

Conversation

@clanghans
Copy link
Copy Markdown
Contributor

@clanghans clanghans commented May 11, 2026

Summary

  • Adds docs/decisions/ directory with an index and the first Decision Record
  • DR-001-Infra documents four design decisions from the unit test infrastructure work in PR feat(test): add unit test infrastructure with py_itf_unittest #94:
    1. Dedicated py_itf_unittest macro (thin wrapper, no plugin machinery)
    2. Surgical Bazel target splitting for atomic dependency scoping
    3. Shared main.py bootstrap pattern for pytest under Bazel
    4. pytest-mock over unittest.mock
  • Naming convention and index structure follow the Eclipse S-CORE DR convention (DR-{number}-{category}.md, glob-based toctree per category)
  • Wires the new decisions/index into the Sphinx toctree

Related: #94
Discussion: https://github.com/orgs/eclipse-score/discussions/2867

Test plan

Documents the four design decisions made in PR eclipse-score#94:
- py_itf_unittest macro (thin wrapper, no plugin machinery)
- surgical Bazel target splitting for atomic deps
- pytest bootstrap via shared main.py
- pytest-mock over unittest.mock

References: eclipse-score#94
@clanghans clanghans force-pushed the feature/dr-unit-test-design branch from 90f8b3d to 67d2f1b Compare May 11, 2026 09:36
@clanghans clanghans marked this pull request as ready for review May 11, 2026 09:45
@AlexanderLanin AlexanderLanin requested a review from Copilot May 11, 2026 10:14
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new “Decisions” documentation section to capture design decision records (DRs) for ITF, starting with DR-001 describing the unit test infrastructure decisions introduced in PR #94.

Changes:

  • Add docs/decisions/ with an index page and the first decision record (DR-001-infra).
  • Wire the new decisions section into the main Sphinx docs toctree.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/index.rst Adds decisions/index to the site-level toctree so the section appears in the docs build.
docs/decisions/index.rst Introduces the Decisions landing page and a globbed toctree for infra DRs.
docs/decisions/DR-001-infra.md Documents the rationale and selected options for the unit test infrastructure design from PR #94.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

2 participants