nuttx icon indicating copy to clipboard operation
nuttx copied to clipboard

Fix Kconfig style

Open simbit18 opened this issue 1 year ago • 1 comments

Summary

drivers/analog/Kconfig drivers/can/Kconfig

Remove spaces from Kconfig files Add TABs

Impact

none

Testing

simbit18 avatar Oct 22 '24 13:10 simbit18

[Experimental Bot, please feedback here]

This PR does not meet the NuttX requirements. Here's why:

  • Insufficient Summary: The summary lacks critical information.
    • Purpose: Why are spaces being removed and tabs added to Kconfig files? Is this for code style consistency, to fix a bug, or another reason?
    • Specifics: Which Kconfig files are affected? The summary should clearly state the scope of the changes.
  • Incomplete Impact Assessment: Even seemingly minor changes can have unintended consequences. The PR needs to address:
    • Build Impact: Will this change how Kconfig files are parsed? Could it break builds on certain systems?
    • Compatibility: Could this impact existing configurations or scripts that rely on the previous formatting?
  • Missing Testing Details:
    • No Environments: The PR needs to specify the build hosts and target platforms where the changes were tested.
    • No Logs: "Testing logs before change" and "Testing logs after change" sections are empty. Provide concrete evidence that the changes work as expected and haven't introduced regressions.

Recommendations

  1. Expand the Summary: Clearly articulate the problem this PR solves or the improvement it introduces. Be specific about which files are modified.
  2. Thoroughly Analyze Impact: Consider potential effects on the build system, compatibility, and user experience.
  3. Provide Detailed Testing Information:
    • List all build hosts (OS, CPU, compiler) and target platforms (architecture, board, configuration).
    • Include relevant logs or output that demonstrate the functionality before and after your changes.

By addressing these points, you'll make your PR easier to review and increase its chances of being accepted.

nuttxpr avatar Oct 22 '24 13:10 nuttxpr