RDKEMW-19315 : Add coding guidelines for firebolt-cpp-client - #91
Merged
Conversation
swethasukumarr
force-pushed
the
feature/RDKEMW-19315
branch
from
July 13, 2026 17:54
f6f989f to
d1058e2
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new repository-scoped coding-guidelines instruction document intended to standardize how contributors (and AI agents) modify firebolt-cpp-client, with emphasis on module boundaries, naming, testing patterns, and generator-owned surfaces.
Changes:
- Introduces a comprehensive “Coding Guidelines” instruction file covering architecture layering, naming, error handling, and JSON adapter conventions.
- Documents expected test patterns (unit/component) and OpenRPC fixture alignment rules.
- Captures build/CMake conventions and a catalog of repo-specific anti-patterns.
satlead
approved these changes
Jul 21, 2026
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.