nuttxpr commented on PR #14017: URL: https://github.com/apache/nuttx/pull/14017#issuecomment-2403795815
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) This Pull Request (PR) description, as it stands, **does not meet the NuttX requirements**. Here's why and how to improve it: **Missing Information:** * **Summary:** * **Why is this change necessary?** Is it a bug fix, optimization, or new feature? Be specific! * **What functional part of the code is being changed?** Mention specific modules, files, or functions. * **How does the change exactly work?** Provide a technical explanation. Don't just say "create stack use the checkstack function" – elaborate on what that means. * **Impact:** * While you say "no impact," you need to confirm this for **each category**. Even if there's no impact, explicitly state "NO" for each to show you've considered it. * **Testing:** * **Insufficient Detail:** "ostest" is not descriptive enough. Specify: * **Which host OS and compiler did you use for building?** * **Which specific target architecture and board configuration did you test on?** * **What do the logs actually show?** Include relevant snippets demonstrating the problem before the change and the improvement after. Don't just paste entire log files. **Example of an Improved PR Description:** ```markdown ## Summary This PR fixes a potential stack overflow issue in the [specific module/function name] by utilizing the `checkstack` function. Previously, [explain the previous behavior and why it was problematic]. This change introduces a check to [explain how `checkstack` is used] ensuring [desired outcome, e.g., early error detection, preventing potential crashes]. Related [NuttX Issue](link to issue if applicable) ## Impact * Is new feature added? Is existing feature changed? NO * Impact on user (will user need to adapt to change)? NO * Impact on build (will build process change)? NO * Impact on hardware (will arch(s) / board(s) / driver(s) change)? NO * Impact on documentation (is update required / provided)? NO * Impact on security (any sort of implications)? NO * Impact on compatibility (backward/forward/interoperability)? NO * Anything else to consider? NO ## Testing I confirm that changes are verified on the following setup and work as intended: * Build Host(s): Ubuntu 20.04, GCC 9.4.0 * Target(s): ARMv7-M, STM32F4 Discovery board (stm32f4discovery) Testing logs before change: ``` [Relevant snippet showing the problem, e.g., stack overflow, unexpected behavior] ``` Testing logs after change: ``` [Relevant snippet showing the fix, e.g., stack check triggered, graceful error handling] ``` ``` **Key Takeaway:** A good PR description is clear, concise, and provides all necessary details for reviewers to understand and evaluate your changes effectively. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
