[Coding Guideline]: Test Again Again Again

[PLeVasseur]

Chapter

Associated Items

Guideline Title

tbd

Category

Mandatory

Status

Draft

Release Begin

tbd

Release End

tbd

FLS Paragraph ID

fls_tbd

Decidability

Decidable

Scope

Module

Tags

numerics

Amplification

No response

Exception(s)

No response

Rationale

tbd

Non-Compliant Example 1 - Prose

tbd

Non-Compliant Example 1 - Code

# use std::mem::MaybeUninit;
# fn main() {
let x: u32 = unsafe { MaybeUninit::uninit().assume_init() }; // UB
# }

Non-Compliant Example 2 - Prose (Optional)

No response

Non-Compliant Example 2 - Code (Optional)

No response

Non-Compliant Example 3 - Prose (Optional)

No response

Non-Compliant Example 3 - Code (Optional)

No response

Non-Compliant Example 4 - Prose (Optional)

No response

Non-Compliant Example 4 - Code (Optional)

No response

Compliant Example 1 - Prose

tbd

Compliant Example 1 - Code

# use std::collections::HashMap;
# fn main() {
let mut map = HashMap::new();
map.insert("key", "value"); // Compliant usage
# }

Compliant Example 2 - Prose (Optional)

No response

Compliant Example 2 - Code (Optional)

No response

Compliant Example 3 - Prose (Optional)

No response

Compliant Example 3 - Code (Optional)

No response

Compliant Example 4 - Prose (Optional)

No response

Compliant Example 4 - Code (Optional)

No response

[github-actions]

👋 Hey @AlexCeleste! You've been assigned to review this coding guideline issue.

Your Role as Reviewer

As outlined in our contribution guide, please:

1. Provide initial feedback within 14 days

2. Work with @PLeVasseur to flesh out the concept and ensure the guideline is well-prepared for a Pull Request

3. Check the prerequisites before the issue is ready to become a PR:

   • The new rule isn't already covered by another rule
   • All sections contain some content
   • Content written may be incomplete, but must not be incorrect
   • The 🧪 Code Example Test Results section shows all example code compiles

4. When ready, add the sign-off: create pr from issue label to signal the contributor should create a PR

Bot Commands

If you need to pass this review:

• @guidelines-bot pass! [reason] - Pass just this issue to the next reviewer
• @guidelines-bot pass-until! YYYY-MM-DD [reason] - Step away from the queue until a date
• @guidelines-bot release - Release your assignment (next in queue will be assigned)

To assign someone else:

• @guidelines-bot assign @username - Assign a specific reviewer
• @guidelines-bot r? producers - Request the next reviewer from the queue

Other commands:

• @guidelines-bot claim - Claim this review for yourself
• @guidelines-bot label +label-name - Add a label
• @guidelines-bot label -label-name - Remove a label
• @guidelines-bot status - Show current queue status

[github-actions]

📋 RST Preview for Coding Guideline

This is an automatically generated preview of your coding guideline in reStructuredText format.

📁 Target Location

Create a new file: src/coding-guidelines/associated-items/gui_C0MhhXO9PapB.rst.inc

Note: The .rst.inc extension prevents Sphinx from auto-discovering the file.
It will be included via the chapter's index.rst.

We add it to this path, to allow the newly added guideline to appear in the correct chapter.

🗂️ Update Chapter Index

Update src/coding-guidelines/associated-items/index.rst to include gui_C0MhhXO9PapB.rst.inc, like so:

Chapter Name Here <- chapter heading inside of `src/coding-guidelines/associated-items/index.rst`
=================

.. include:: gui_7y0GAMmtMhch.rst.inc -| existing guidelines
.. include:: gui_ADHABsmK9FXz.rst.inc  |
...                                    |
...                                    |
.. include:: gui_RHvQj8BHlz9b.rst.inc  |
.. include:: gui_dCquvqE1csI3.rst.inc -|
.. include:: gui_C0MhhXO9PapB.rst.inc <- your new guideline to add

🧪 Code Example Test Results

✅ All 2 code example(s) compiled successfully!

Note: Code examples are tested with rustc --edition=2021.
Hidden lines (prefixed with # ) are included in compilation.
Examples without a fn main() are automatically wrapped.

📝 How to Use This

Option A: Automatic (Recommended)

Once this issue is approved, a maintainer will add the sign-off: create pr from issue label, which automatically creates a PR with the guideline file.

Option B: Manual

1. Fork the repository (if you haven't already) and clone it locally
2. Create a new branch from main:

   git checkout main
   git pull origin main
   git checkout -b guideline/your-descriptive-branch-name

3. Create the guideline file:

   mkdir -p src/coding-guidelines/associated-items

4. Copy the RST content below into a new file named gui_C0MhhXO9PapB.rst.inc
5. Update the chapter index - Add an include directive to src/coding-guidelines/associated-items/index.rst:

   .. include:: gui_C0MhhXO9PapB.rst.inc

   Keep the includes in alphabetical order by guideline ID.
6. Build locally to verify the guideline renders correctly:

   ./make.py

7. Commit and push your changes:

   git add src/coding-guidelines/associated-items/
   git commit -m "Add guideline: <your guideline title>"
   git push origin guideline/your-descriptive-branch-name

8. Open a Pull Request against main

📄 Click to expand RST content

.. SPDX-License-Identifier: MIT OR Apache-2.0
   SPDX-FileCopyrightText: The Coding Guidelines Subcommittee Contributors

.. guideline:: tbd
            :id: gui_C0MhhXO9PapB
            :category: mandatory
            :status: draft
            :release: tbd-tbd
            :fls: fls_tbd
            :decidability: decidable
            :scope: module
            :tags: numerics





            .. rationale::
                :id: rat_mZsWgNHDrpBn
                :status: draft

                tbd

.. non_compliant_example::
    :id: non_compl_ex_eTxgwbq8Qv2Q
    :status: draft

    tbd

    .. rust-example::

        # use std::mem::MaybeUninit;
        # fn main() {
        let x: u32 = unsafe { MaybeUninit::uninit().assume_init() }; // UB
        # }


.. compliant_example::
    :id: compl_ex_hSETIYrZ8IXJ
    :status: draft

    tbd

    .. rust-example::

        # use std::collections::HashMap;
        # fn main() {
        let mut map = HashMap::new();
        map.insert("key", "value"); // Compliant usage
        # }

---

_{🤖 This comment was automatically generated from the issue content. It will be updated when you edit the issue body.}