nuttxpr commented on PR #14693: URL: https://github.com/apache/nuttx/pull/14693#issuecomment-2463687399
[**\[Experimental Bot, please feedback here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues) This PR template does a good job of outlining the information needed for a NuttX contribution. However, it could be improved with a few tweaks to make it clearer and more actionable for contributors. Here's a revised template: ```markdown # NuttX Pull Request ## Summary * **What problem does this solve?** (bug fix, enhancement, new feature) Be specific and concise. * **What code is affected?** (e.g., drivers/sensors, sched/, net/...) * **How does this change address the problem?** Briefly explain the technical approach. * **Related Issue:** (e.g., `Fixes #1234`, `Part of #5678`) Link to the NuttX issue, if applicable. * **Related NuttX Apps Issue/PR:** Link to the NuttX Apps issue or PR, if applicable. ## Impact Please answer YES or NO for each question and provide a brief explanation if YES. * **New Feature?** [ ] YES / [ ] NO (If YES, describe the new functionality) * **User Impact?** [ ] YES / [ ] NO (If YES, how will users be affected? Will they need to change their code or configuration?) * **Build Impact?** [ ] YES / [ ] NO (If YES, how will the build process be affected? New dependencies? New configuration options?) * **Hardware Impact?** [ ] YES / [ ] NO (If YES, which architectures, boards, or drivers are affected?) * **Documentation Impact?** [ ] YES / [ ] NO (If YES, does documentation need updating? Has documentation been updated as part of this PR?) * **Security Impact?** [ ] YES / [ ] NO (If YES, describe any potential security implications) * **Compatibility Impact?** [ ] YES / [ ] NO (If YES, describe any backward/forward compatibility or interoperability issues) * **Other Considerations?** (Anything else reviewers should be aware of?) ## Testing * **Build Host(s):** OS (e.g., Linux Ubuntu 20.04), CPU (e.g., x86_64), Compiler (e.g., GCC 9.4.0) * **Target(s):** Architecture (e.g., sim, RISC-V, ARM Cortex-M4), Board:Config (e.g., stm32f4discovery:nsh) **Verification Steps:** (Clearly describe the steps taken to test this change. Be specific!) **Test Results:** * **Before Change:** ``` (Paste relevant logs or output demonstrating the issue before the change. If a new feature, describe the expected behavior.) ``` * **After Change:** ``` (Paste relevant logs or output demonstrating the fix or new functionality.) ``` ``` **Key improvements:** * **Clearer questions:** Rephrased questions in the Impact section to be more direct and specific. Checkboxes added for YES/NO answers. * **Emphasis on "What problem does this solve?"**: This encourages contributors to clearly articulate the purpose of their change. * **Specific code area:** Asking for the affected code area helps reviewers quickly understand the scope of the change. * **Verification Steps:** Added a section for explicit test steps. This is crucial for reviewers to understand how the changes were validated and to reproduce the testing if necessary. * **Before/After Expectations:** Encouraged including the expected behavior *before* the change, especially for new features, or describing the problem being solved. This clarifies the context for the "After Change" results. This revised template is more structured and provides clearer guidance for contributors, leading to higher-quality pull requests and a smoother review process. -- 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]
