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

   [**\[Experimental Bot, please feedback 
here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues)
   
   
   
   No, this PR description does not fully meet the NuttX requirements.  Here's 
why and how to fix it:
   
   **Missing Information in Summary:**
   
   * **Why is the change necessary?** What was the original problem with the 
FDCAN configuration?  Was it not working?  Were there errors?  Be specific.  
Example: "Fixes an issue where FDCAN configuration on the linum-stm32h753bi 
board prevented proper communication using socketcan."
   * **What functional part of the code is being changed?**  Which 
files/modules were modified?  For example:  "Modifies the FDCAN driver and 
board configuration files for the linum-stm32h753bi."
   * **How does the change exactly work?**  This needs more detail.  Don't just 
say "Use socketcan."  Explain the technical details of the fix.  For example: 
"Corrected the bit timing settings in the board configuration.  Added handling 
for X feature in the FDCAN driver.  Enabled Y interrupt."
   * **Issue References:** Are there any related NuttX or NuttX Apps issues or 
pull requests?  If so, provide the links.
   
   
   **Missing Information in Impact:**
   
   *  Most of the impact sections are answered with "NO" implicitly. Explicitly 
state "NO" for clarity.
   * **Impact on User:** Even if the answer is no, explain briefly why. 
Example: "NO.  Existing applications using socketcan should work correctly 
after this fix."
   * **Impact on hardware:** You mentioned the linum board.  Be specific: "YES. 
 Changes the FDCAN configuration on the linum-stm32h753bi board."
   * **Impact on Documentation:** If no documentation changes are needed, state 
"NO.  This fix does not require documentation updates."  If the fix *should* 
have documentation updates, then the PR should include them.
   
   **Issues with Testing:**
   
   * **Build Host:**  Provide details about your build host environment. 
Example: "Linux, x86_64, GCC 12.2.0"
   * **Target:**  You mentioned linum, but be more specific about the 
configuration: "linum-stm32h753bi:socketcan"
   * **Testing logs before change:**  You need to show the output *before* the 
fix was applied.  This demonstrates the problem that the PR is solving. Show 
the errors or incorrect behavior.
   * **Testing logs after change:** The "after" logs demonstrate that the fix 
works.  Your current logs look good, but make sure they show the complete and 
successful operation.
   
   
   **Example of an Improved Summary:**
   
   ```
   This PR fixes an issue where FDCAN communication was not working correctly 
on the linum-stm32h753bi board when using the socketcan driver. The problem was 
caused by incorrect bit timing settings in the board configuration and a 
missing interrupt handler in the FDCAN driver.  This PR modifies the 
`stm32_fdcan.c` driver and the `linum-stm32h753bi/configs/socketcan/defconfig` 
board configuration file.  The fix corrects the bit timing parameters to match 
the CAN bus requirements and adds the necessary interrupt handling to ensure 
reliable data transmission and reception.  Resolves #[NuttX Issue Number, if 
applicable].
   ```
   
   
   By providing more complete information, you significantly improve the review 
process and increase the chances of your PR being merged quickly.
   


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