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

   [**\[Experimental Bot, please feedback 
here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues)
   
   __Fill In The Commit Message:__ This PR contains a Commit with an Empty 
Commit Message. Please fill in the Commit Message with the PR Summary.
   
   
   
   The PR summary is missing some key information required by the NuttX PR 
guidelines. Here's a breakdown:
   
   **Missing Information:**
   
   * **What functional part of the code is being changed?**  Be specific. Is it 
the USB driver? The CDC/NCM driver? A DMA driver?
   * **How does the change exactly work?** Simply saying "moved the assignment" 
is not descriptive enough. Explain *why* the assert was likely there, what 
conditions would cause it to trigger, and how moving the assignment addresses 
the root problem. 
   * **Related Issues:** Are there any related issues on the NuttX or NuttX 
Apps repositories? Even if not, state that explicitly.
   
   **"Impact" Section Concerns:**
   
   * **Too many "None expected"**:  While it's possible there's no user-facing 
impact, you can't assume this about aspects like build processes or hardware 
compatibility.  Instead of saying "None Expected", be explicit if something is 
not applicable (e.g., "Build: N/A"). If you're unsure, say so! 
   * **DMA Expertise Needed:** You acknowledge needing reviewers with DMA 
knowledge.  Highlight this explicitly in the "Impact" section to attract the 
right reviewers.
   
   **Testing:**
   
   * **Insufficient Detail:** "Custom board" is too vague. Provide:
       * The exact board name (if it's a common one) or a link to its 
schematic/documentation.
       * The NuttX configuration you used (e.g., `sama5d27c_som1_ek_defconfig`).
   * **No Logs:**  The template asks for logs *before* and *after* the change. 
Provide these, even if they're simple.
   
   **How to Improve:**
   
   1. **Be Specific:**  Don't assume reviewers understand the context. Explain 
the problem and your solution in detail.
   2. **Address All Points:** Even if something doesn't apply, acknowledge it 
in your PR.
   3. **Provide Evidence:** Back up your claims about testing and impact with 
logs and clear explanations.
   
   By addressing these points, you'll make it much easier for maintainers to 
review and merge your PR. 
   


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

Reply via email to