nuttxpr commented on PR #14065: URL: https://github.com/apache/nuttx/pull/14065#issuecomment-2405248858
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) Let's break down if this Pull Request (PR) description meets NuttX's requirements. **Strengths:** * **Addresses a Standard:** Clearly states the problem: the `assert` macro deviates from the C standard. * **Technical Explanation:** Provides a concise technical explanation of the changes made. * **Mentions Compilation Error:** Highlights the tangible benefit (fixing a compilation issue). * **Testing Environment:** Indicates testing was done on a simulator ("sim"). **Weaknesses & Missing Information:** * **Incomplete Summary:** * **Why is this change necessary?** While mentioning the standard is good, explain the real-world implications of the non-standard behavior (e.g., portability issues, unexpected behavior with certain compilers). * **What functional part is changed?** Be specific. Is it within the C standard library implementation of NuttX? A header file? * **How does it work?** You describe *what* changes but not exactly *how*. For example, what code replaces the `do-while` structure? * **Impact Section is Empty:** This is critical! Address *all* the bullet points, even if the answer is "NO" with a brief justification. For example: * **New feature?** Likely NO, this is a bug fix. * **Impact on user?** Potentially YES if users relied on the non-standard behavior. * **Impact on build?** Possibly YES if the fix changes include paths or dependencies. * **Testing is Insufficient:** * **Build Host Details:** Provide specifics about your development environment (OS, compiler version, etc.). * **Target Details:** "sim" is too vague. Which simulator? What architecture does it emulate? * **No Logs:** Include actual snippets of build logs or test output demonstrating the problem before and the solution after the change. **To improve this PR description:** 1. **Expand the Summary:** Provide more context and details as outlined above. 2. **Complete the Impact Section:** Thoroughly assess and describe the impact of your changes. 3. **Provide Detailed Testing Information:** Be specific about your build host, target environment, and include relevant log snippets. By addressing these points, you'll create a much stronger PR that's easier for maintainers to review and merge. -- 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]
