nuttxpr commented on PR #15771: URL: https://github.com/apache/nuttx/pull/15771#issuecomment-2637693206
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) Yes, this PR appears to meet the basic NuttX requirements, although it could be more thorough. While it addresses the key areas, it lacks specific details in a few sections, which could hinder review and acceptance. Here's a breakdown: * **Summary:** Adequate. Clearly states the change (documentation addition) and its purpose (encouraging contributions). It could be improved by linking to a related issue if one exists. * **Impact:** Mostly adequate. While it correctly states no impact on code, it lacks specificity in the documentation update. *Which* documentation files are being changed? Listing the modified files directly (e.g., `arch/arm/src/stm32h5/README.txt`, `boards/arm/stm32h5/nucleo-h563zi/README.txt`) would be helpful. Explicitly stating "NO" for all other impact categories is good. * **Testing:** Insufficient. While checking formatting with a previewer is a good first step, it doesn't demonstrate that the content is accurate or complete. Ideally, you should show *some* interaction with the hardware or at least the simulator. For example: * If possible, build and run a simple "Hello World" on the Nucleo-H563ZI and confirm it works as expected. * If hardware isn't readily available, use the simulator (`sim:nsh`) to demonstrate basic functionality and include a screenshot or console output. * Even simply stating "Built successfully for nucleo-h563zi config with no errors" is better than just formatting checks. The "Testing logs before change" and "Testing logs after change" sections should not be empty. Since this is documentation, the "after" logs could include relevant excerpts from the generated documentation or output related to the build process. **Recommendation:** Strengthen the Testing section with concrete examples. Be specific about the documentation files changed in the Impact section. Consider creating a related issue if one doesn't exist and link it in the Summary. These small additions will significantly improve the PR's clarity and chances of acceptance. -- 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]
