nuttxpr commented on PR #2947: URL: https://github.com/apache/nuttx-apps/pull/2947#issuecomment-2591804366
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) No, this PR description does not adequately meet the NuttX requirements. While it touches on the required sections, it lacks crucial details. Here's a breakdown of what's missing and how it can be improved: **Summary:** * **Insufficient Detail:** "Driver test issue fix" is too vague. Which driver? What was the specific issue? Was it a bug, a performance problem, a missing feature in the test itself? * **Missing Links:** If this relates to an existing issue in either the NuttX or NuttX Apps repositories, the PR description *must* include links to those issues. **Impact:** * **Insufficient Detail:** "Driver test issue" is again too vague. The impact sections require YES/NO answers followed by descriptions *if* the answer is YES. Even if all answers are NO, a brief justification is helpful (e.g., "NO - This change is isolated to the test code and does not affect the driver's runtime behavior."). Consider these questions: * **New Feature?** Is a new test case being added? * **Existing Feature Changed?** Is an existing test case being modified? * **User Impact?** Likely no, but explain why. * **Build Impact?** Likely no, but explain why. * **Hardware Impact?** Likely no, but explain why. * **Documentation Impact?** Maybe, if the driver's behavior changed and documentation needs updating. * **Security Impact?** Unlikely for a test change, but consider if the original bug had security implications. * **Compatibility Impact?** Unlikely for a test change, but consider if this affects how other drivers or tests interact. **Testing:** * **Insufficient Detail:** "local test" is inadequate. Provide specifics: * **Build Host:** e.g., "Linux Ubuntu 20.04, x86_64, GCC 9.4.0" * **Target:** e.g., "sim:qemu-x86_64" or "stm32f4discovery:nsh" * **Missing Logs:** The template *requires* "before" and "after" logs. These logs demonstrate the issue and its resolution. Even if the change is small, include relevant snippets of output that show the test failing before and passing after. **Example of an Improved PR Description:** ``` ## Summary This PR fixes an issue in the I2C driver test where the test would incorrectly report a failure when reading data from a specific register. The issue was caused by an incorrect offset calculation within the test code. This change corrects the offset calculation, allowing the test to correctly read the register value. Related [NuttX Issue](https://github.com/apache/nuttx/issues/1234) ## Impact * Is new feature added? NO - This is a bug fix in an existing test. * Impact on user (will user need to adapt to change)? NO - This change only affects the test code and has no impact on the driver's runtime behavior. * Impact on build (will build process change)? NO - No changes to the build system are required. * Impact on hardware (will arch(s) / board(s) / driver(s) change)? NO - This change only affects the test code and does not modify the driver itself. * Impact on documentation (is update required / provided)? NO - No documentation updates are required. * Impact on security (any sort of implications)? NO - This issue did not have any security implications. * Impact on compatibility (backward/forward/interoperability)? NO - This change does not affect compatibility. * Anything else to consider? No. ## Testing I confirm that changes are verified on local setup and works as intended: * Build Host(s): Linux Ubuntu 22.04, x86_64, GCC 11.2.0 * Target(s): sim:qemu-cortex-m3 Testing logs before change: ``` ... I2C Test Failed: Expected 0x12, Received 0x00 ... ``` Testing logs after change: ``` ... I2C Test Passed ... ``` ``` By providing more specific information and following the template closely, you'll significantly improve the review process and increase the likelihood of your PR being merged quickly. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
