docs(decisions): add DR-001 for unit test design#105
Open
clanghans wants to merge 1 commit into
Open
Conversation
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
90f8b3d to
67d2f1b
Compare
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/decisions/directory with an index and the first Decision Recordpy_itf_unittestmacro (thin wrapper, no plugin machinery)main.pybootstrap pattern for pytest under Bazelpytest-mockoverunittest.mockDR-{number}-{category}.md, glob-based toctree per category)decisions/indexinto the Sphinx toctreeRelated: #94
Discussion: https://github.com/orgs/eclipse-score/discussions/2867
Test plan
bazel build //docs)