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

   [**\[Experimental Bot, please feedback 
here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13494&type=pullrequests)
   
   
   
   This PR appears to be missing some key information required by the NuttX PR 
guidelines. 
   
   **Here's a breakdown of what's missing and how to improve it:**
   
   **Summary:**
   
   * **Insufficient Detail:** "bug fix, lzf.h header file reference adds macro 
package" is too vague. 
       * **What specific bug was fixed?**  Provide a clear description of the 
bug and its symptoms. Ideally, reference a specific NuttX Issue number.
       * **Why was the macro package added to lzf.h?** Explain the technical 
reason and how it solves the bug.
   
   **Impact:**
   
   * **Too Brief:** "Libc LZF Modules" doesn't explain the impact. 
       * **Functionality:**  Was any existing functionality changed by this bug 
fix? 
       * **Users:** Will users notice any difference after this change?
       * **Build:** Will the build process be affected (new dependencies, 
compiler flags, etc)?
       * **Other Impacts:** Go through the rest of the impact checklist 
(hardware, documentation, security, compatibility) and clearly state "NO" or 
provide details if "YES."
   
   **Testing:**
   
   * **Incomplete Information:**
       * **Host Details:** Specify the full compiler version (e.g., GCC 13.1.x).
       * **Target Details:** "SIM" is not enough. Specify the simulator used 
(e.g., qemu-system-arm). Also, provide the full board configuration name (e.g., 
sim:nsh).
       * **Missing Logs:**  The testing logs sections are empty.  You **must** 
provide:
           * **Before Change Logs:** Showing the error or problem caused by the 
bug.
           * **After Change Logs:** Demonstrating that the bug is fixed and the 
code works correctly.
   
   **To summarize, here's what you need to add to your PR:**
   
   1. **Detailed bug description and solution in the Summary.**
   2. **Comprehensive impact analysis, addressing all checklist items.**
   3. **Complete testing information, including host/target specifics and 
relevant logs demonstrating the bug fix.** 
   
   By providing this information, you'll make it much easier for reviewers to 
understand and approve your PR. 
   


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