nuttxpr commented on PR #15896:
URL: https://github.com/apache/nuttx/pull/15896#issuecomment-2677826508
[**\[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. It is
far too brief and lacks critical information. Here's a breakdown of the
missing pieces:
**Summary:**
* **Missing:** The summary is extremely vague. What *specific* change is
being made? What problem does it solve (fix)? Or what new capability does it
provide (new feature)? The phrase "based on spec, 16 bytes alignment is
checked" doesn't tell us what "spec" or what is being checked *for* that
alignment. What was the behavior *before* this change?
* **Missing:** What functional part of the code is changed? Mention the
specific files/modules/functions affected. e.g., "Changes the block driver
interface," or "Modifies the encryption handling in the flash driver."
* **Missing:** *How* does the change work? Saying "both block write and
byte write are supported" is a result, not an explanation. Describe the
mechanism used to achieve this. Did you add a new function? Modify an existing
one? Change a data structure?
* **Missing:** Links to related NuttX issues or NuttX Apps issues/PRs.
**Impact:**
While the PR touches on some impact areas, the answers are too short to be
helpful. "YES" should always be followed by a detailed explanation.
* **Missing Detail:** "both block write and byte write are supported now,
but 16 bytes alignment is required" should be broken down. Is this a *new*
requirement? Will any existing code break because of this requirement? Which
architectures/boards are affected?
* **All other impact areas are effectively unanswered.** Even if the answer
is NO, briefly explain why. For example, "Impact on build: NO (No changes to
Makefiles or build configuration)"
**Testing:**
* **Insufficient:** "tested by internal test case" is not enough. What
internal test case? Give its name or location.
* **Missing Logs:** Placeholder logs are present, but actual logs
demonstrating the before/after behavior are missing. The logs should show that
the intended change was made and that it works correctly. Include relevant
information like inputs, outputs, and error messages.
* **Missing Details on Test Environment:** Be much more specific about the
build host and target. Instead of just "Linux," specify the distribution and
version (e.g., "Ubuntu 22.04"). Provide the compiler version (e.g., "GCC
11.2.0"). For the target, specify the architecture, board, and configuration
(e.g., "sim:qemu-x86_64:nsh").
**In short, the PR description needs significant expansion to meet the NuttX
requirements. It needs to be more detailed, specific, and provide evidence of
testing and consideration of the impact of the changes.**
--
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
