nuttxpr commented on PR #15803: URL: https://github.com/apache/nuttx/pull/15803#issuecomment-2648646024
[**\[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, but it's missing some crucial details. While it addresses the summary and testing sections reasonably well, the impact section needs significant improvement. Here's a breakdown of what's missing and how to improve it: * **Impact - More Detail Required:** Simply saying "Users can read the documentation and run NuttX" is insufficient. You need to explicitly answer *all* the impact questions with "YES" or "NO" and provide details if the answer is "YES." Since this is documentation, most answers will likely be "NO," but you still need to state that explicitly. For example: * **Is new feature added?** NO * **Is existing feature changed?** NO * **Impact on user (will user need to adapt to change)?** NO * **Impact on build (will build process change)?** NO * **Impact on hardware (will arch(s) / board(s) / driver(s) change)?** NO. *This is where you might mention the XIAO nRF52840 support if this documentation enables its use in some way.* * **Impact on documentation (is update required / provided)?** YES (Documentation for the XIAO nRF52840 board is added.) * **Impact on security (any sort of implications)?** NO * **Impact on compatibility (backward/forward/interoperability)?** NO * **Anything else to consider?** NO * **Testing - Target Specificity:** While you describe *how* you tested, you don't specify the *target*. Did you just build the documentation or did you also test the instructions on an actual XIAO nRF52840 board? Be explicit. If you tested on the hardware, include the specific configuration (e.g., `nrf52840-dk:nsh`). If you only tested the documentation build, state that clearly. **Example of an improved Testing section:** ``` Build the documentation and checked the rendered output: Build Host: Linux, x86_64, GCC 12.2.0 Target: Documentation Build (No on-target testing performed yet) cd Documentation/ pipenv shell make html xdg-open _build/html/index.html (OR, if you tested on hardware) Build Host: Linux, x86_64, GCC 12.2.0 Target: nrf52840-xiao:nsh cd Documentation/ pipenv shell make html xdg-open _build/html/index.html # Then tested the build instructions on the XIAO nRF52840 with the nsh configuration. # (Add details about what commands you ran and the expected output.) ``` By providing more complete and specific information, especially in the Impact and Testing sections, your PR will be much easier 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: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
