nuttxpr commented on PR #15698: URL: https://github.com/apache/nuttx/pull/15698#issuecomment-2614288031
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) No, this PR description does not meet the NuttX requirements. It's far too brief and lacks crucial information. Here's a breakdown of what's missing and how to fix it: **Summary:** * **Insufficient Detail:** Simply referencing another PR isn't enough. You must summarize the change *within this PR's description*. Explain the *why*, *what*, and *how* of the change independently. Copy-pasting from the other PR is acceptable, but ensure the context is clear for someone reviewing *this* PR specifically. * **Missing Issue References:** If this PR addresses a specific issue in either the NuttX or NuttX Apps repositories, provide the full issue URL (e.g., `https://github.com/apache/nuttx/issues/1234`). **Impact:** * **Completely Empty:** This section is crucial. You *must* address each point, even if the answer is "NO." For "NO" answers, a simple "NO" is sufficient. However, for "YES" answers, provide a concise explanation of the impact. For example: * **Impact on user:** YES (Users will now need to configure option XYZ in their .config file to enable this feature.) * **Impact on hardware:** YES (This change adds support for the ABC sensor on the DEF board.) * **Consider all points:** Don't skip any of the impact categories. Even seemingly minor changes can have unforeseen consequences. **Testing:** * **Insufficient Information:** "ci" is not enough. While CI testing is important, you also need to provide details about your *local* testing. * **Missing Details:** Specify the exact build host OS, CPU architecture, compiler version, target architecture, board, and configuration. Be precise. For example: * Build Host: macOS Ventura (Intel Core i7), GCC 12.2 * Target: sim:nsh * **No Logs:** The "Testing logs before change" and "Testing logs after change" sections are empty. You *must* provide relevant logs demonstrating the issue before the change and the correct behavior after the change. These logs should clearly show the impact of your changes. Even if the change is small, include *some* output demonstrating the difference. **Example of a better Testing section:** ``` 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.3.0 * Target(s): sim:nsh Testing logs before change: ``` nsh> help ls ls: not found ``` Testing logs after change: ``` nsh> help ls ls: list directory contents usage: ls [-l] [<path>] ``` ``` By providing more complete information, reviewers can understand your changes, assess their impact, and verify that they work as intended. A well-written PR description significantly speeds up the review process and increases the likelihood of your contribution being accepted. -- 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
