nuttxpr commented on PR #2686:
URL: https://github.com/apache/nuttx-apps/pull/2686#issuecomment-2406905002

   [**\[Experimental Bot, please feedback 
here\]**](https://github.com/search?q=repo%3Aapache%2Fnuttx+13552&type=issues)
   
   
   
   This PR does not meet the NuttX requirements. Here's why and how to improve 
it:
   
   **Missing Information:**
   
   * **Summary:** 
       * **Why is this change necessary?** Is there a bug report or feature 
request this addresses?  
       * **What functional part of the code is being changed?** Be specific. 
Which files, modules, or functions are affected?
       * **How does the change work?** Explain the technical details of your 
solution.
   * **Impact:**
       * **Is this a new feature or a change to an existing one?**
       * **You've only mentioned "Nsh" - be more specific.** How does this 
affect Nsh users? Do they need to change their commands? 
       * **Impact on other areas is unclear.**  Address all "Impact" points in 
the template. Even if the answer is "NO", state it explicitly.
   * **Testing:**
       * **"sim" is insufficient.** Which simulator? Which configuration?
       * **Provide actual testing logs** both before and after the change to 
demonstrate the issue and the fix.
   
   **How to Improve Your PR:**
   
   1. **Expand the Summary:**  Provide a clear and detailed explanation of the 
problem, solution, and related issues.
   2. **Complete the Impact Section:** Address each bullet point, providing 
specific details about the effects of your changes.
   3. **Provide Detailed Testing Information:** Include:
       * Simulator used (e.g., qemu-system-arm)
       * NuttX configuration (e.g., `configs/sim/arm/nsh`)
       * Relevant commands used and their output (both before and after your 
changes)
   
   **Example of Improved Summary:**
   
   > This PR fixes a bug in the Nsh command-line parser where single (') and 
double (") quotation marks were not correctly handled when passed as arguments 
to commands. This resulted in commands misinterpreting arguments containing 
these characters. The change modifies the `parser.c` file to properly escape 
and handle quotation marks, ensuring that commands receive the intended 
arguments. This addresses Issue #[Issue Number] (if applicable). 
   
   By providing complete and clear information, you make it easier for 
reviewers to understand and approve your changes, leading to a faster and 
smoother integration 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: commits-unsubscr...@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to