Document design rational for global variable
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- cpp
- Domain
- backend, documentation
Research direction
Search the repository for the global variable score::mw::log::gBackendCreators and read how the backends are registered into it. Review the architecture checklist quoted in the issue, then document the design rationale for using this global backend variable. Done means the rationale is added where the project keeps its design documentation and clearly covers this variable.
Written by the indexing model from the issue text.
Description
What
The architecture checklist has the point:
Indicators of complexity include: the number of use cases
(corresponding to dynamic diagrams) allocated to a single design
element, the number of interfaces and operations in an interface,
function parameters, global variables, complex types, and limited
comprehensibility.
Notes:
If the "number of use cases" or "number of interfaces" above exceeds
"3" or "number of function parameters" exceeds "5" or the "number of
operations" exceeds "20" or global variables are used, a design
rationale is mandatory.
Since the backends are registered into a global variable score::mw::log::gBackendCreators this needs to have a design rational.
Acceptance Criteria (DoD)
- Create a design rational for the global backend variable
score::mw::log::gBackendCreators
How
No response
- Dominant language
- C++
- Stars
- 2
- Forks
- 28
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 21
Contributor guide
No contributing guide indexed for this repository
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/logging
-
wp:architecture
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
eclipse-score/logging#314 ·
-
wp:architecture
Difficulty 2/5 Half a day Newbie friendliness 68/100
eclipse-score/logging#312 ·
-
bb:feature-logging ft:LOG wp:safety-mgmt
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
eclipse-score/logging#202 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
eclipse-score/logging#321 ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
eclipse-score/logging#320 ·
All issues in eclipse-score/logging
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
games-on-whales/wolf#509 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
bug-unconfirmed
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
NVIDIA/cuda-samples#453 ·