Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

{bp-15373} Documentation: add NuttX 12.8.0 Release notes #15374

Merged
merged 2 commits into from
Dec 28, 2024

Conversation

jerpelea
Copy link
Contributor

Summary

add NuttX 12.8.0 Release notes
add NuttX 12.7.0 Release notes

Impact

RELEASE

Testing

NONE

Add release notes for 12.7.0 release

Signed-off-by: Alin Jerpelea <[email protected]>
Add release notes for 12.8.0 release

Signed-off-by: Alin Jerpelea <[email protected]>
@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: XL The size of the change in this PR is very large. Consider breaking down the PR into smaller pieces. labels Dec 28, 2024
@nuttxpr
Copy link

nuttxpr commented Dec 28, 2024

[Experimental Bot, please feedback here]

No, this PR does not fully meet the NuttX requirements. While it mentions adding release notes, it lacks crucial details.

Here's why:

  • Insufficient Summary: Simply stating "add release notes" isn't enough. The summary should explain what changes are included in those release notes (bug fixes, new features, etc.), which parts of NuttX are affected, and how these changes work.
  • Vague Impact: Marking "RELEASE" under impact is too broad. It needs to specify the impact on users, the build process, hardware, documentation, security, and compatibility based on the changes listed in the release notes. For example, if a new feature is introduced, how will users use it? Does it require any configuration changes? Are any existing features deprecated?
  • Missing Testing: "NONE" is unacceptable for a release. Release notes imply changes, and changes require testing. The PR needs to demonstrate that the documented changes work as intended. Even if the changes themselves weren't tested as part of this specific PR (because they were tested in previous PRs), the release notes should be tested for accuracy and completeness. At a minimum, the PR should confirm that the release notes accurately reflect the changes included in the release.

In short, the PR needs to elaborate significantly on what changes are being documented, how they impact NuttX, and provide evidence that the release notes themselves are accurate and complete.

@anchao anchao merged commit 15d91f5 into apache:releases/12.8 Dec 28, 2024
3 checks passed
@jerpelea jerpelea deleted the bp-15373 branch December 29, 2024 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation Size: XL The size of the change in this PR is very large. Consider breaking down the PR into smaller pieces.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants