nuttxpr commented on PR #13578:
URL: https://github.com/apache/nuttx/pull/13578#issuecomment-2367333358

   [**\[Experimental Bot, please feedback 
here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues)
   
   
   
   The provided PR description is **missing crucial information** and **does 
not meet the NuttX requirements.** 
   
   Here's a breakdown:
   
   **Missing Information:**
   
   * **Insufficient Summary:** 
       *  **Why:**  While it mentions a bug fix, it lacks a clear explanation 
of the problem the fix addresses.  What were the symptoms of the bug? 
       * **What:** The description of the functional change is too vague.  Be 
specific about the code files modified and the logic adjusted.
       * **How:** The explanation of how the change works is insufficient. 
Provide a concise, technical overview of the implemented solution.
       * **Links:** No related NuttX issues or pull requests are linked. This 
context is essential for reviewers.
   * **Incomplete Impact Assessment:**
       * **Feature Impact:** The description only states "all 
CONFIG_FS_REFCOUNT and CONFIG_DUMP_ON_EXIT config," which isn't informative 
enough. Clearly state if this is a bug fix only or introduces any functional 
changes. 
       * **User Impact:** Does this fix change any user-facing behavior? Be 
explicit.
       * **Build Impact:** While it mentions a "Procedure," it's unclear what 
this means. Specify any build system changes required.
       * **Other Impacts:**  The remaining impact categories are completely 
unaddressed.
   * **Insufficient Testing:**
       * **Environment Details:** The testing environment description is too 
generic. Provide specific details about:
           * Build Host OS, CPU architecture, compiler version
           * Target architecture (simulator, specific hardware), board name, 
NuttX configuration used
       * **Missing Logs:** "your testing logs here" is unhelpful.  Include 
actual relevant log snippets demonstrating:
           * The problem before the fix
           * The successful outcome after the fix
   
   **Recommendations to Meet Requirements:**
   
   1. **Expand the Summary:** 
       * Clearly articulate the bug's symptoms and impact.
       * Provide specific details about the code being changed.
       * Explain the solution's technical implementation concisely.
       * Link any relevant NuttX issues or pull requests.
   
   2. **Complete the Impact Assessment:**
       * Address all impact categories with "YES" or "NO."
       * Provide detailed explanations for each "YES," clearly outlining the 
changes and their implications.
   
   3. **Provide Thorough Testing Information:**
       * Specify the exact build host and target environments.
       * Include real log snippets that demonstrate the bug and the successful 
fix. 
   
   By addressing these points, you will create a PR that is informative, meets 
NuttX's standards, and facilitates efficient review. 
   


-- 
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]

Reply via email to