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

Doc: Fortify Instructions #15658

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Doc: Fortify Instructions #15658

merged 1 commit into from
Jan 23, 2025

Conversation

W-M-R
Copy link
Contributor

@W-M-R W-M-R commented Jan 23, 2025

Note: Please adhere to Contributing Guidelines.

Summary

Doc: Fortify Instructions

Impact

Update this section, where applicable, on how change affects users,
build process, hardware, documentation, security, compatibility, etc.

Testing

Update this section with details on how did you verify the change,
what Host was used for build (OS, CPU, compiler, ..), what Target was
used for verification (arch, board:config, ..), etc. Providing build
and runtime logs from before and after change is highly appreciated.

@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small labels Jan 23, 2025
@nuttxpr
Copy link

nuttxpr commented Jan 23, 2025

[Experimental Bot, please feedback here]

No, this PR does not fully meet the NuttX requirements. While it provides a summary title, it lacks crucial details:

  • Missing Detailed Summary: The summary only states the title "Doc: Fortify Instructions". It needs to explain why fortify instructions are being added/updated, what part of the documentation is affected, how the instructions work/changed, and any related issue references.

  • Incomplete Impact Assessment: The impact section is a placeholder. It must be filled out with specific YES/NO answers and descriptions for each impact category. Even if the impact is "NO" for most categories, it's important to explicitly state that. For documentation, it should at least say YES and specify which documentation files were modified.

  • Missing Testing Information: The testing section is also a placeholder. It must be filled with specific details about the testing environment (host OS, compiler, target architecture/board) and, ideally, include before/after logs demonstrating the effect of the documentation change (e.g., showing how a user would use the new/updated instructions). Even if the change is purely documentation, testing might involve building the documentation to confirm it renders correctly.

In short, the PR needs to provide specific information in the Impact and Testing sections to meet the requirements. The Summary also needs to be expanded.

Signed-off-by: wangmingrong1 <[email protected]>
@xiaoxiang781216 xiaoxiang781216 merged commit 4946051 into apache:master Jan 23, 2025
3 checks passed
========

Overview
--------
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use heading levels according to https://nuttx.apache.org/docs/latest/contributing/documentation.html#headings

=================
Top Level Heading
=================

Subsection
==========

Subsubsection
-------------

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: S The size of the change in this PR is small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants