[Coding Guideline]: tbd

[PLeVasseur]

Chapter

Associated Items

Guideline Title

tbd

Category

Mandatory

Status

Draft

Release Begin

tbd

Release End

tbd

FLS Paragraph ID

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

Bibliography

No response

[github-actions]

👋 Hey @CartesianXR7! 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 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 /away YYYY-MM-DD [reason] - Step away from the queue until a date
• @guidelines-bot /release [@username] [reason] - Release assignment (yours or someone else's with triage+ permission)

To assign someone else:

• @guidelines-bot /r? @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 /rectify - Reconcile this issue/PR review state from GitHub
• @guidelines-bot /label +label-name - Add a label
• @guidelines-bot /label -label-name - Remove a label
• @guidelines-bot /queue - Show reviewer queue
• @guidelines-bot /commands - Show all available commands

[github-actions]

📋 RST Preview for Coding Guideline

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

🧪 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.

📁 Target Location

Create a new file:

• src/coding-guidelines/associated-items/gui_tG6xhswRHzm4.rst

Create the guideline page like this:

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

.. default-domain:: coding-guidelines

tbd
===

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



    .. rationale::
        :id: rat_VBmjj3YizaCx
        :status: draft

        tbd

    .. non_compliant_example::
        :id: non_compl_ex_fpB7lf6LZQ5W
        :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_n9sK4KhoRzms
        :status: draft

        tbd

        .. rust-example::

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

🗂️ Update Chapter Index

Ensure src/coding-guidelines/associated-items/index.rst lists guideline pages with a toctree:

.. toctree::
   :maxdepth: 1
   :titlesonly:
   :glob:

   gui_*

With :glob: you do not need to add the new guideline manually.

📝 How to Use This

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 directory:

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

4. Copy the RST content below into a new file named gui_tG6xhswRHzm4.rst
5. Ensure the chapter index src/coding-guidelines/associated-items/index.rst contains the toctree block:

    .. toctree::
       :maxdepth: 1
       :titlesonly:
       :glob:
   
       gui_*

   With :glob: you do not need to update the index per guideline.
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

.. default-domain:: coding-guidelines

tbd
===

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



    .. rationale::
        :id: rat_VBmjj3YizaCx
        :status: draft

        tbd

    .. non_compliant_example::
        :id: non_compl_ex_fpB7lf6LZQ5W
        :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_n9sK4KhoRzms
        :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.}

[felix91gr]

@guidelines-bot /claim

[github-actions]

✅ @felix91gr has claimed this review.

[felix91gr]

Lorem ipsum dolor sit amet, something something