Skip to content

ReadMe.rst: Fix header formatting, path separators, and grammar#12402

Merged
ardbiesheuvel merged 1 commit intotianocore:masterfrom
pohaosu:fix-readme
Apr 13, 2026
Merged

ReadMe.rst: Fix header formatting, path separators, and grammar#12402
ardbiesheuvel merged 1 commit intotianocore:masterfrom
pohaosu:fix-readme

Conversation

@pohaosu
Copy link
Copy Markdown
Contributor

@pohaosu pohaosu commented Apr 6, 2026

  • Correct header underline lengths to meet ReStructuredText standards.
  • Standardize path separators to forward slashes for consistency.
  • Fix grammar and improve phrasing in the Submodules section.

Description

  • Breaking change?
    • Breaking change - Does this PR cause a break in build or boot behavior?
    • Examples: Does it add a new library class or move a module to a different repo.
  • Impacts security?
    • Security - Does this PR have a direct security impact?
    • Examples: Crypto algorithm change or buffer overflow fix.
  • Includes tests?
    • Tests - Does this PR include any explicit test code?
    • Examples: Unit tests or integration tests.

How This Was Tested

Integration Instructions

- Correct header underline lengths to meet ReStructuredText standards.
- Standardize path separators to forward slashes for consistency.
- Fix grammar and improve phrasing in the Submodules section.

Signed-off-by: Phineas Su <pohaosu@google.com>
@tianocore-pr-automation
Copy link
Copy Markdown

Pull Request Formatting Issues

⚠️ Remove the following template lines from your PR description:
<_Include a description of the change and why this change was made._>
<_For each item, place an "x" in between [and]if true. Example:[x] (you can also check items in GitHub UI)_>
<_Create the PR as a Draft PR if it is only created to run CI checks._>
<_Delete lines in \<\> tags before creating the PR._>
<_Describe the test(s) that were run to verify the changes._>
<_Describe how these changes should be integrated. Use N/A if nothing is required._>

Address these issues and the validation will automatically re-run when you update your pull request.

@ardbiesheuvel
Copy link
Copy Markdown
Member

Please don't merge back the master branch into your topic branch - this will be taken care of at merge time.

@pohaosu
Copy link
Copy Markdown
Contributor Author

pohaosu commented Apr 13, 2026

@ardbiesheuvel oh, thank you for the reminding! Just reverted them

@ardbiesheuvel ardbiesheuvel merged commit 4d15c94 into tianocore:master Apr 13, 2026
47 of 183 checks passed
@pohaosu pohaosu deleted the fix-readme branch April 13, 2026 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants