RDKEMW-11903: Add custom coding guidelines for entservices-repos #185

ssitar583 · 2025-12-22T18:59:41Z

Reason for change: To enhance copilot reviews using repo specific guidelines
Test Procedure:NA
Risks: Low
version: Patch
Signed-off-by: Soundaryaa [email protected]

Reason for change: To enhance copilot reviews using repo specific guidelines Test Procedure:NA Risks: Low version: Patch Signed-off-by: Soundaryaa [email protected]

Copilot

Pull request overview

This PR introduces custom coding guidelines for the entservices repositories to enhance Copilot code reviews. The guidelines provide comprehensive documentation for Thunder plugin development standards and best practices.

Key Changes:

Added seven instruction files covering plugin lifecycle, implementation patterns, configuration, and CMake usage
Created copilot-instructions.md to standardize how review comments should reference these guidelines
Established guidelines for module naming, inter-plugin communication, and onboarding compliance

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
`.github/instructions/Pluginmodule.instructions.md`	Defines MODULE_NAME conventions and declaration requirements for Thunder plugins
`.github/instructions/Pluginlifecycle.instructions.md`	Specifies mandatory Initialize, Deinitialize, and Deactivated lifecycle methods with resource management rules
`.github/instructions/Pluginimplementation.instructions.md`	Documents inter-plugin communication patterns using COM-RPC and on-demand interface acquisition
`.github/instructions/Pluginconfig.instructions.md`	Outlines plugin configuration file structure and mandatory properties (callsign, autostart, mode)
`.github/instructions/Plugincmake.instructions.md`	Enforces NAMESPACE variable usage instead of hardcoded framework names in CMake files
`.github/instructions/PluginOnboardingCompliance.instructions.md`	Details Coverity scan and CI workflow updates required when adding new plugins
`.github/instructions/Plugin.instructions.md`	Covers interface implementation, service registration, JSON-RPC stub usage, and out-of-process failure handling
`.github/copilot-instructions.md`	Establishes format for linking review comments to specific guideline sections in instruction files

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

Copilot · 2025-12-22T19:03:21Z

.github/instructions/Pluginimplementation.instructions.md

+uint32_t ret = m_SystemPluginObj->Invoke<JsonObject, JsonObject>(THUNDER_RPC_TIMEOUT, _T("getFriendlyName"), params, Result);
+```
+
+Use COM-RPC for plugin event registration by passing a C++ callback interface pointer for low-latency communication. It is important to register for StateChange notifications to monitor the notifying plugin's lifecycle. This allows you to safely release the interface pointer upon deactivation and prevents accessing a non-existent service.


Missing word in sentence. It should read "This allows you to safely release" instead of "This allows you safely release".

Copilot · 2025-12-22T19:03:21Z

.github/instructions/Pluginimplementation.instructions.md

+}
+```
+
+If the notifying plugin supports only JSON-RPC, then use a specialized smart link type when subscribing to its events. This method allows the framework to efficiently handle Plugin statechange events.


The word "statechange" should be written as two words: "state change" for better readability and consistency with standard terminology.

Suggested change

If the notifying plugin supports only JSON-RPC, then use a specialized smart link type when subscribing to its events. This method allows the framework to efficiently handle Plugin statechange events.

If the notifying plugin supports only JSON-RPC, then use a specialized smart link type when subscribing to its events. This method allows the framework to efficiently handle Plugin state change events.

Copilot · 2025-12-22T19:03:21Z

.github/instructions/Pluginconfig.instructions.md

@@ -0,0 +1,49 @@
+---
+applyTo: "**/*.config,**/*.conf.in"


The config file naming pattern shows ".config" and ".conf.in" as separate patterns, but based on the content and example at line 34, it should be "/*.conf.in" only. The pattern "/*.config" doesn't match the documented ".conf.in" file extension.

Suggested change

applyTo: "**/*.config,**/*.conf.in"

applyTo: "**/*.conf.in"

.github/instructions/PluginOnboardingCompliance.instructions.md

Copilot · 2025-12-22T19:03:22Z

.github/instructions/Plugin.instructions.md

+
+These autogenerated stubs are the Exchange::J* C++ classes (for example, Exchange::JHdcpProfile and JsonData_HdcpProfile.h) that are produced by the Thunder JSON‑RPC code generator from the IPluginName* interface headers; they expose the C++ interface over JSON‑RPC so you do not have to call Register() for each method manually.
+
+Plugins using autogenerated JSON-RPC stubs (Exchange::J* classes) must register and unregister them in Initialize() and Deinitialize() methods.It should not be done in constructor and destructor.


The requirement description uses "It should not be done" which is passive voice and ambiguous about who is responsible. Consider rephrasing to active voice: "Do not register and unregister them in the constructor and destructor."

Suggested change

Plugins using autogenerated JSON-RPC stubs (Exchange::J* classes) must register and unregister them in Initialize() and Deinitialize() methods.It should not be done in constructor and destructor.

Plugins using autogenerated JSON-RPC stubs (Exchange::J* classes) must register and unregister them in Initialize() and Deinitialize() methods. Do not register or unregister them in the constructor or destructor.

Copilot · 2025-12-22T19:03:23Z

.github/instructions/Pluginlifecycle.instructions.md

+
+### Deactivated
+
+Each plugin should implement the deactivated method. In Deactivated, it should be checked if remote connectionId matches your plugin's connectionId. If it matches your plugin's connectionId, the plugin should submit a deactivation job to handle the out-of-process failure gracefully.


The word "Plugin" should be lowercase when referring to the method name. The sentence should read "Each plugin should implement the Deactivated method" (with capital D for the method name) rather than "the deactivated method".

Suggested change

Each plugin should implement the deactivated method. In Deactivated, it should be checked if remote connectionId matches your plugin's connectionId. If it matches your plugin's connectionId, the plugin should submit a deactivation job to handle the out-of-process failure gracefully.

Each plugin should implement the Deactivated method. In Deactivated, it should be checked if remote connectionId matches your plugin's connectionId. If it matches your plugin's connectionId, the plugin should submit a deactivation job to handle the out-of-process failure gracefully.

Copilot · 2025-12-22T19:03:23Z

.github/instructions/Pluginimplementation.instructions.md

+_userSettingsPlugin = _service->QueryInterface<WPEFramework::Exchange::IUserSettings>();
+```
+
+SHOULD not use JSON-RPC or LinkType for inter-plugin communication, as they introduce unnecessary overhead.


The phrase "SHOULD not use" should be changed to "should not use" (lowercase) for consistency with standard documentation conventions, or use "MUST NOT" if this is a strict requirement following RFC 2119 terminology.

Suggested change

SHOULD not use JSON-RPC or LinkType for inter-plugin communication, as they introduce unnecessary overhead.

should not use JSON-RPC or LinkType for inter-plugin communication, as they introduce unnecessary overhead.

Copilot · 2025-12-22T19:03:23Z

.github/instructions/Pluginimplementation.instructions.md

+}
+```
+
+If the notifying plugin supports only JSON-RPC, then use a specialized smart link type when subscribing to its events. This method allows the framework to efficiently handle Plugin statechange events.


Missing article before "specialized". The sentence should read "then use a specialized smart link type" instead of "then use specialized smart link type".

Copilot · 2025-12-22T19:03:23Z

.github/instructions/Plugin.instructions.md

+
+### Requirement
+
+- If the plugin runs as out-of-process, then it should implement RPC::IRemoteConnection::"INotification interface inside your plugin.


There's a double colon typo in the requirement. Change 'RPC::IRemoteConnection::"INotification interface' to 'RPC::IRemoteConnection::INotification interface' (remove the extra quote mark).

Suggested change

- If the plugin runs as out-of-process, then it should implement RPC::IRemoteConnection::"INotification interface inside your plugin.

- If the plugin runs as out-of-process, then it should implement RPC::IRemoteConnection::INotification interface inside your plugin.

.github/instructions/Pluginimplementation.instructions.md

Reason for change: To enhance copilot reviews using repo specific guidelines Test Procedure:NA Risks: Low version: Patch Signed-off-by: Soundaryaa [email protected]

RDKEMW-11903: Add custom coding guidelines for entservices-repos

d01141e

Reason for change: To enhance copilot reviews using repo specific guidelines Test Procedure:NA Risks: Low version: Patch Signed-off-by: Soundaryaa [email protected]

Copilot AI review requested due to automatic review settings December 22, 2025 18:59

ssitar583 requested a review from a team as a code owner December 22, 2025 18:59

Copilot started reviewing on behalf of ssitar583 December 22, 2025 19:00 View session

Copilot AI reviewed Dec 22, 2025

View reviewed changes

RDKEMW-11903: Add custom coding guidelines for entservices-repos

c1c352a

Reason for change: To enhance copilot reviews using repo specific guidelines Test Procedure:NA Risks: Low version: Patch Signed-off-by: Soundaryaa [email protected]

suppal045 approved these changes Dec 24, 2025

View reviewed changes

suppal045 merged commit 3586575 into develop Dec 24, 2025
10 checks passed

github-actions bot locked and limited conversation to collaborators Dec 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

RDKEMW-11903: Add custom coding guidelines for entservices-repos #185

RDKEMW-11903: Add custom coding guidelines for entservices-repos #185

Uh oh!

ssitar583 commented Dec 22, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 22, 2025

Uh oh!

Copilot AI Dec 22, 2025

Uh oh!

Copilot AI Dec 22, 2025

Uh oh!

Uh oh!

Copilot AI Dec 22, 2025

Uh oh!

Copilot AI Dec 22, 2025

Uh oh!

Copilot AI Dec 22, 2025

Uh oh!

Copilot AI Dec 22, 2025

Uh oh!

Copilot AI Dec 22, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	If the notifying plugin supports only JSON-RPC, then use a specialized smart link type when subscribing to its events. This method allows the framework to efficiently handle Plugin statechange events.
	If the notifying plugin supports only JSON-RPC, then use a specialized smart link type when subscribing to its events. This method allows the framework to efficiently handle Plugin state change events.


		These autogenerated stubs are the Exchange::J* C++ classes (for example, Exchange::JHdcpProfile and JsonData_HdcpProfile.h) that are produced by the Thunder JSON‑RPC code generator from the IPluginName* interface headers; they expose the C++ interface over JSON‑RPC so you do not have to call Register() for each method manually.

		Plugins using autogenerated JSON-RPC stubs (Exchange::J* classes) must register and unregister them in Initialize() and Deinitialize() methods.It should not be done in constructor and destructor.


		### Deactivated

		Each plugin should implement the deactivated method. In Deactivated, it should be checked if remote connectionId matches your plugin's connectionId. If it matches your plugin's connectionId, the plugin should submit a deactivation job to handle the out-of-process failure gracefully.

	SHOULD not use JSON-RPC or LinkType for inter-plugin communication, as they introduce unnecessary overhead.
	should not use JSON-RPC or LinkType for inter-plugin communication, as they introduce unnecessary overhead.


		### Requirement

		- If the plugin runs as out-of-process, then it should implement RPC::IRemoteConnection::"INotification interface inside your plugin.

RDKEMW-11903: Add custom coding guidelines for entservices-repos #185

RDKEMW-11903: Add custom coding guidelines for entservices-repos #185

Uh oh!

Conversation

ssitar583 commented Dec 22, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants