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

   [**\[Experimental Bot, please feedback 
here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues)
   
   
   
   This PR does not meet the NuttX requirements fully. Here's why and how to 
improve it:
   
   **What's Missing/Needs Improvement**
   
   * **Summary:** 
       *  **Too Vague:**  "Fix some build error" is not informative enough. Be 
specific about what errors occurred and in which context. 
       *  **Missing Details:** Briefly explain *why* these errors happen and 
how your changes address the root cause.
   * **Impact:**
       * **CI Only?**  While CI impact is important, consider these:
           *  **Functionality:**  Did the build errors prevent any features 
from working? If so, mention those features are now fixed.
           *  **Users:**  Will any user workflows be affected (even if 
indirectly)?
           *  **Portability:**  Do these fixes affect specific architectures or 
boards?
   * **Testing:**
       * **CI is Not Enough:**  While CI passing is good,  provide *specific* 
test cases you ran locally:
           * What configurations did you test (boards, architectures, features 
enabled)?
           *  Ideally, include snippets of successful build logs (or error 
messages if relevant) *before* and *after* your changes. 
   
   **Example of an Improved Summary**
   
   > **Fix Build Errors Related to ARCH_MATH_H and Header File Inclusions**
   
   > This PR addresses several build errors encountered when using the 13.2 
toolchain:
   > * The `sim` architecture now requires `ARCH_MATH_H` to be explicitly 
enabled for proper math function usage.
   > * Missing header file inclusions in `lib_gdbstub`, `bluetooth`, and 
`tls.h` have been corrected to resolve compilation issues. 
   > * These errors prevented successful builds in CI and potentially impacted 
users of the affected components.
   
   **Additional Tips**
   
   * **Link to Issues:** If these build errors were reported in any NuttX 
issues, reference them for better context.
   * **Conciseness:** Be clear and informative, but avoid unnecessary 
wordiness. 
   * **Audience:** Write for someone familiar with NuttX, but who doesn't have 
your specific context on the issue. 
   


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

Reply via email to