Update README with getting started instructions#1
Conversation
Added instructions for getting started with the logging repository. Signed-off-by: devendrapat <[email protected]>
Signed-off-by: devendrapat <[email protected]>
|
Add brief README onboarding note and extend This PR adds a short introductory sentence in the This summary was automatically generated by @propel-code-bot |
![propel-code-bot[bot]](https://avatars.githubusercontent.com/in/1179004?s=60&v=4){kind=small}
There was a problem hiding this comment.
Found minor maintainability concerns about public API exposure and a syntax fix.
Status: Minor Suggestions | Risk: Medium
Issues Identified & Suggestions
- Keep test-only enums out of public API contract:
score/datarouter/error/error.h - Add missing comma to prevent compile error:
score/datarouter/error/error.h
Review Details
📁 2 files reviewed | 💬 1 comments
👍 / 👎 individual comments to help improve reviews for you
| kNoFileFound = 1, | ||
| kParseError, | ||
| kNoChannelsFound | ||
| kThisEnumIsOnlyForTesting |
There was a problem hiding this comment.
[Maintainability] The new enumerant kThisEnumIsOnlyForTesting is added to the public LoggingErrorCode contract even though it is strictly for tests. Because this header is the shipped error-domain interface, exposing a test-only value leaks test concerns across the API boundary and invites downstream code to depend on a code that has no runtime meaning, making later removal a breaking change. Keep test-only error codes in test-only headers or behind conditional compilation so the public API continues to describe only production errors.
Additionally, there's a missing comma after kNoChannelsFound on line 30 — without it, this code will not compile. If the test-only enumerant is retained (even temporarily), add the comma: kNoChannelsFound,.
Context for Agents
The new enumerant `kThisEnumIsOnlyForTesting` is added to the public `LoggingErrorCode` contract even though it is strictly for tests. Because this header is the shipped error-domain interface, exposing a test-only value leaks test concerns across the API boundary and invites downstream code to depend on a code that has no runtime meaning, making later removal a breaking change. Keep test-only error codes in test-only headers or behind conditional compilation so the public API continues to describe only production errors.
Additionally, there's a missing comma after `kNoChannelsFound` on line 30 — without it, this code will not compile. If the test-only enumerant is retained (even temporarily), add the comma: `kNoChannelsFound,`.
File: score/datarouter/error/error.h
Line: 311 participant
Added instructions for getting started with the logging repository.
@auto